From b8d946a4f14f7e32df9f3ddc325931283b771d8e Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Fri, 25 Oct 2024 18:47:14 +0200
Subject: update class diagram & readme

---
 readme.md | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

(limited to 'readme.md')

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
 
-- 
cgit v1.2.3