diff options
| author | WBoerenkamps <wrj.boerenkamps@student.avans.nl> | 2024-10-23 21:15:58 +0200 |
|---|---|---|
| committer | WBoerenkamps <wrj.boerenkamps@student.avans.nl> | 2024-10-23 21:15:58 +0200 |
| commit | b5e83d076f356c6d01b7bbc1f033db4850356c0d (patch) | |
| tree | c4b11f86c6ab1685e46fab9d674377a39e612fd7 /readme.md | |
| parent | 51c8a51b53a850265955a3e4bc45b40ad3f8c477 (diff) | |
| parent | 04a040e28ade412ea5b1767bf77eed3956121973 (diff) | |
pull origin master
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 38 |
1 files changed, 33 insertions, 5 deletions
@@ -7,18 +7,46 @@ This repository contains: |`lib/`|third-party libraries as git submodules| |`mwe/`|minimal working examples and proof-of-concepts| |`src/crepe/`|game engine source code| -|`test/`|game engine unit tests| +|`src/test/`|unit tests| +|`src/example/`|standalone examples using game engine| ## Compilation This repository uses CMake (the makefile in the root of this repository is for -running auxiliary tasks only). Make sure you have initialized and updated the -submodules before compiling. +running auxiliary tasks only). See [src/readme.md](src/readme.md) for detailed +building instructions. + +## Installing libraries + +The expected library (source) versions are included in this repository as git +submodules. Follow these steps for manually building one of the required +libraries from source: + +1. Ensure the git submodules are initialized: + ``` + $ git submodule update --init --recursive --depth 1 + ``` +2. `cd` into the library source folder: + ``` + $ cd lib/googletest + or + $ cd lib/sdl2 + or + $ cd lib/soloud/contrib + ``` +3. Configure the build, run the build and install: + ``` + $ cmake -B build -G Ninja + $ ninja -C build + # ninja -C build install + ``` ## Documentation -API documentation is done using Doxygen. To generate the docs, run `make -doxygen`. +API documentation is done using Doxygen. To generate the docs, run +``` +$ make doxygen +``` ## Code style |