diff --git a/README.md b/README.md index 0d4ec65..6fe941f 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,8 @@ Smol little game engine since I have no idea what I'm doing Since this uses the newer cpp modules, you need to make sure your compiler + build system + IDE supports this. You can find more info [on this stack overflow post](https://stackoverflow.com/questions/57300495/how-to-use-c20-modules-with-cmake). + +## Building +Find more info about building the project in the `docs/Building.md` file. + +(CMake >= 3.28) \ No newline at end of file diff --git a/docs/Building.md b/docs/Building.md index 38e1e28..ca73be9 100644 --- a/docs/Building.md +++ b/docs/Building.md @@ -1,7 +1,7 @@ # Building ICEngine supports both single and multi type configuration types: -Make/Ninja +Make/Ninja (NOTE: MingW Makefiles do not support modules which this project uses!) ```bash cmake -S . -B build -DCMAKE_BUILD_TYPE=Release @@ -17,3 +17,17 @@ cmake -S . -B build -G "Visual Studio 16 2019" # or your preferred Visual Studio cmake --build build --config Debug cmake --build build --config Release ``` + +## Toolchain Versions +#### CMake +This project requires CMake 3.28 or greater, due to its support for C++ Modules. + +#### Compilers +I have only ever tried to build using the following tools and versions: + +- **Ninja**: 1.12.1 +- **Clang**: 18.1.8 +- **C++/GCC**: 14.2.0 + +If you have issues building on your target platform or compiler, please ensure they can use C++'s `modules` (required by +the project) \ No newline at end of file