diff options
| author | jaroWMR <jarorutjes07@gmail.com> | 2024-10-20 13:07:02 +0200 |
|---|---|---|
| committer | jaroWMR <jarorutjes07@gmail.com> | 2024-10-20 13:07:02 +0200 |
| commit | 4ff1159fe5f6ee6dd8becc662bc95a93acda545a (patch) | |
| tree | 670caa42ad4ffbf007a6d7cba683f4f84af87592 /readme.md | |
| parent | 0f03cdbf23f57116b7664a7c98c4605fd69bb961 (diff) | |
| parent | 77555730e3ddb811b9ce8470659663e3f1573de2 (diff) | |
Merge branch 'master' of github.com:lonkaars/crepe into jaro/poc-physics
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 37 |
1 files changed, 32 insertions, 5 deletions
@@ -8,18 +8,45 @@ This repository contains: |`mwe/`|minimal working examples and proof-of-concepts| |`src/crepe/`|game engine source code| |`src/test/`|unit tests| -|`src/example`|standalone examples using game engine| +|`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 |