aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-09-27 14:00:57 +0200
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-09-27 14:00:57 +0200
commita78f7bbfcdabad9550afe22f615b973b92cb074f (patch)
tree318e888219965634e3b81be9b74a0522af2136e0 /readme.md
parent86a7bd1aee2ee96079e00e2696a624fd6b642fa0 (diff)
parentf4560e02f703f1c6f857c8e5af63fa9fc4ca6438 (diff)
fixed merge conflict
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 4974694..f3aab09 100644
--- a/readme.md
+++ b/readme.md
@@ -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).