chore(docs): update build instructions

This commit is contained in:
illyum 2024-09-15 01:44:52 -06:00
parent 4a47835d6f
commit 557d106428
2 changed files with 20 additions and 1 deletions

View File

@ -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 Since this uses the newer cpp modules, you need to make sure your compiler + build system + IDE supports this. You can
find more find more
info [on this stack overflow post](https://stackoverflow.com/questions/57300495/how-to-use-c20-modules-with-cmake). 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)

View File

@ -1,7 +1,7 @@
# Building # Building
ICEngine supports both single and multi type configuration types: 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 ```bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release 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 Debug
cmake --build build --config Release 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)