You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CMakeLists.txt
+58-85
Original file line number
Diff line number
Diff line change
@@ -8,32 +8,32 @@
8
8
### Be sure to define your system's triplet to ensure correct target architecture (32/64-bit). https://vcpkg.readthedocs.io/en/latest/users/triplets/#additional-remarks
General use of CMake comes down to running `cmake configure` and `cmake generate` (please look up [KitWare's documentation](https://cmake.org/documentation/) to learn more).
Some IDEs such as Visual Studio, Visual Studio Code, and CLion come with CMake support or offer "CMake Tools" extensions that allow you to generate the build files from your IDE.
14
+
On Windows, you can also use CMake-gui.
55
15
56
-
// Be sure to get your own images, these are not provided with the Git repository
57
-
Lepus3D::Texture2D firstTx("container.jpg"); // Loads from Solution/Content/
58
-
testMat.SetAttributeTex("_Texture1", firstTx);
16
+
The project is primarily built with Visual C++ 2022 during development and [GCC 11.4.0 on GitHub Actions](https://github.com/tomezpl/LepusEngine/actions),
17
+
and as such those are the "officially supported" compilers at this time.
59
18
60
-
Lepus3D::Transform transform;
61
-
62
-
sf::Clock timer;
19
+
#### Dependencies
20
+
This project uses [vcpkg](https://vcpkg.io/) to locate and install dependencies, such as code libraries, while keeping the need for platform-specific configuration down to a minimum (or none).
engine.EndScene(); // Finish drawing (display in window)
75
-
running = engine.Update();
76
-
}
77
-
engine.Shutdown();
78
-
return 0;
79
-
}
80
-
```
22
+
vcpkg integrates with CMake via a CMake toolchain file. Provided you have a `VCPKG_ROOT` environment variable pointing at your **bootstrapped vcpkg** path,
23
+
the CMakeLists script for LepusEngine should automatically pick up the toolchain file and install the dependencies as needed.
24
+
See [Microsoft's vcpkg documentation](https://learn.microsoft.com/en-gb/vcpkg/get_started/get-started?pivots=shell-powershell) for more details.
81
25
82
-
Check the header files to see how things work. [RenderEngine.h](https://github.com/tomezpl/LepusEngine/blob/master/Lepus3D/Source/RenderEngine.h) is usually a good place to start.
26
+
Additionally, some open-source cross-platform dependencies, such as gl3w and imgui are included in the `3rdparty` directory.
27
+
For imgui, you'll need to run `git submodule update` in order to fetch code from the imgui repository before building LepusEngine.
83
28
84
-
### Contributing
85
-
I myself am focused on creating the renderer. However, I plan on making this a full game engine, and any help would be appreciated.
29
+
### Usage
30
+
See the ["demo" example program](https://github.com/tomezpl/LepusEngine/tree/master/src/examples/demo) for an example of how to use the engine's API.
86
31
87
-
If you have any questions you can contact me at **[email protected]**. If there are any pull requests I'll try to merge them into **master** (assuming they work).
88
32
89
33
### Licensing
90
34
LepusEngine is licensed under the MIT license. This means you are free to use LepusEngine in any way you want, but you must include the copyright notice and the permission notice.
0 commit comments