aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-10-25 18:47:14 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-10-25 18:47:14 +0200
commitb8d946a4f14f7e32df9f3ddc325931283b771d8e (patch)
tree557e437f838e88569d950999f5bd2259c4035677 /readme.md
parentb3a54e9b149ae2df289d6719b02972ff3694ee21 (diff)
update class diagram & readme
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 42c9aaf..93cbf4a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,14 @@
-# TODO
+This is a standard CMake project. To build (using Ninja), run:
-- update class diagram
-- triple check class diagram
+```
+$ cmake -B build -G Ninja
+$ ninja -C build
+```
+
+This project uses the following third-party dependencies, which must be
+installed globally before building this project:
+
+- [SDL3](https://github.com/libsdl-org/SDL) 3.1.3
+- [cpr](https://github.com/libcpr/cpr) 1.11.0
+- [pugixml](https://github.com/zeux/pugixml) 1.14