From 5a7c450282bc1164cd73e6a95c899a5bfeeeeb10 Mon Sep 17 00:00:00 2001
From: onelin <oscar@nelin.dk>
Date: Wed, 9 Apr 2025 12:06:34 +0200
Subject: Add some light source overview documenation

---
 src/README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 src/README.md

(limited to 'src')

diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..3b59c05
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,37 @@
+# DAW Source documenation
+
+The source code is "organized" (ha ha) into modules, where a light effort has
+been made to make each as contained as time has allowed.
+
+It is planned to put module-API documentation, and technical details in each
+sub-module under a `docs` folder, when time comes around to a consistent and
+stable API.
+
+# core
+
+Core loop and initialization module, couples it all together in the messiest way
+possible.
+
+
+# ctrl
+
+Input handling module. Arguably this could be a submodule of the "rendering"
+module as the ctrl module is heavily dependent on it.
+
+
+# rendering
+
+Rendering backend and window handling support. Currently The only platform
+library supported is GLFW with OpenGL support (using GLAD), but it would be neat
+to add SDL support back in at some point, once everything is nicely decoupled.
+
+
+# resources
+
+Resource loading and manipulation.
+
+
+# utils
+
+General utilities like common data structures and neat algorithms to make game
+development a little easier.
-- 
cgit v1.3