aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-21 15:43:14 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-21 15:43:20 +0200
commita12702c912ae0ce96c754ffcb2ab5d901c504b65 (patch)
tree98d921c19ca689a4b82d300de9df79b24552e4c5 /readme.md
parent44affb6635359ef2f619562800165ccfff438ae4 (diff)
remove lazy.mk and update readme
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).