IsoEngine/README.md

36 lines
986 B
Markdown

# ICEngine
Smol little game engine since I have no idea what I'm doing
# Notice:
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)
# Using the engine as a library
You're more than welcome to use this engine for your game. The recommended way to build the project is using CMake:
### Fetch Content:
```cmake
# Enable FetchContent module
include(FetchContent)
# Fetch the external repository
FetchContent_Declare(
ICEngine
GIT_REPOSITORY http://proudcricle:3001/illyum/ICEngine.git
GIT_TAG main
)
# Then add your sources and executable
add_executable(MyGame main.cpp)
# Link the ICEngine library to your project
target_link_libraries(MyGame PRIVATE ICEngine)
```