diff options
| author | 0scar <qgt268@alumni.ku.dk> | 2024-02-06 16:46:09 +0000 |
|---|---|---|
| committer | 0scar <qgt268@alumni.ku.dk> | 2024-02-06 16:46:09 +0000 |
| commit | d2978c6a589556bd43b60ff63f01a8d22fba8821 (patch) | |
| tree | 86f77b77854ea808969215d3314894970428e10e | |
| parent | 1c4b303621b08e8e0e43a5412ff0a1b4cd8d2ae1 (diff) | |
Add build information
| -rw-r--r-- | README.md | 22 |
1 files changed, 21 insertions, 1 deletions
@@ -41,6 +41,26 @@ and plan out a more solid organizational strategy for the project as a whole. See [this CMakeLists.txt][0] to get an idea of how to use this project. +## Building + +_At the moment building with statically linking is borked._ + +Generate the build files using +``` +cmake -S . -B build +``` + +And build the project with +``` +cmake --build build +``` + +This should, in theory, build the engine as a shared library and run without any +warnings nor errors. + +The way the engine is designed, it is very useless as a shared library, and does +nothing if it is not configured as a subproject of the "game" itself. +See [tools/cmake/DawAddState.cmake](tools/cmake/DawAddState.cmake) for more information. ## Planned features @@ -48,7 +68,7 @@ This is an incomplete list of features that are either under development or planned to implement. * Audio -* GLFW & Vulkan support +* GLFW & OpenGL * Better cross platform support (ie. windows) [0]: https://github.com/0undefined/rogue/blob/a947b0092d91920d56eb9af6a39bd1bd05e145fc/CMakeLists.txt |
