summaryrefslogtreecommitdiff
path: root/docs/project-layout.md
diff options
context:
space:
mode:
authoromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-07-19 11:03:21 +1000
committeromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-07-19 11:03:21 +1000
commitf926234600af1883c2be259360b44173bb7c12b4 (patch)
tree8938056cf43f7fc1fa5c2362ee022c5599ac8b28 /docs/project-layout.md
parent0942a484a90695749f05d49273951f2b8d452866 (diff)
updating docs
Diffstat (limited to 'docs/project-layout.md')
-rw-r--r--docs/project-layout.md27
1 files changed, 24 insertions, 3 deletions
diff --git a/docs/project-layout.md b/docs/project-layout.md
index 74a84aa..3d8f466 100644
--- a/docs/project-layout.md
+++ b/docs/project-layout.md
@@ -1,9 +1,30 @@
---
-title: Project Layout
+title: Project Structure
---
```
deps/ - third-party dependencies
docs/ - these docs you're reading now that get built with mkdocs
-TODO: the rest...
-``` \ No newline at end of file
+src/
+ core/ - core game engine facilities
+ logos/ -
+ maths/
+ platform/
+ ral/
+ render/
+ resources/
+ std/
+ systems/
+ ui/
+```
+
+
+#### Core
+
+Core holds specifically functionality vital to making games or 3D applications. Contrast this with `std` which contains
+code that could form the base layer of almost any software out there.
+
+#### Std
+
+Data structures, algorithms, memory management, etc - all code here forms a foundation for everything above it and can conceivably
+be reused in non-game applications. \ No newline at end of file