diff options
author | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-22 11:35:47 +0200 |
---|---|---|
committer | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-22 11:35:47 +0200 |
commit | 176ac90fce318334f1377d94d6e637e1eff84c3c (patch) | |
tree | 104b86fc3537fd82c7b9dd731ee716c51441ca31 /readme.md | |
parent | edfcb27fe37fdcf08622863f331960325e3899ac (diff) | |
parent | 77555730e3ddb811b9ce8470659663e3f1573de2 (diff) |
Merge branch 'master' into niels/rendering
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 |