diff options
author | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-01 11:05:42 +0200 |
---|---|---|
committer | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-01 11:05:42 +0200 |
commit | 8e66301577551bc5b8a2e169be173e71de2f5e4e (patch) | |
tree | 52797ebfe53007eaf502c9cf9aafbd34817f5d0b /readme.md | |
parent | 2d13805218eb34b6e06205c1b65c341ebcdad504 (diff) | |
parent | f4560e02f703f1c6f857c8e5af63fa9fc4ca6438 (diff) |
Merge branch 'master' into niels/resource-manager
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 24 |
1 files changed, 22 insertions, 2 deletions
@@ -1,6 +1,26 @@ # crêpe -systems programming in c++ minor engine +This repository contains: -please read [contributing.md](./contributing.md) +|folder|content| +|-|-| +|`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| + +## 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. + +## Documentation + +API documentation is done using Doxygen. To generate the docs, run `make +doxygen`. + +## Code style + +Please read [contributing.md](./contributing.md). |