aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorrtk0c <[email protected]>2025-08-16 11:49:02 -0700
committerrtk0c <[email protected]>2025-08-16 11:49:02 -0700
commit21da7e16ec4104fa7a4fe489f2c371520e037cc6 (patch)
tree97a654a74799f316c364f1e1a455128f2a95261c /README.md
parented1031d0d122117fa93870da34e6784aeeffdf6d (diff)
Update README project structureHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index 9bebd97..d467188 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,15 @@
## Project Structure
- `cmake`: CMake scripts consumed by the root `CMakeLists.txt`.
-- `10-common`: Code that's compiled as a part of all targets. Check each target's build script for details.
-- `20-codegen-compiler`: Code generator similar to Qt MOC.
-- `20-codegen-runtime`: Code that's consumed along with output of `buildtools/codegen`.
-- `30-game`: The main game.
+- `brussel.common`: The "standard library" of this project, included on all targets. Check each target's build script for details.
+- `brussel.engine`: Shared engine code, included on all targets. Not quite feeling "standard library", more specific to this project.
+- `brussel.editor`: Shared editor code. Can be disabled on a release build.
+ - TODO: move the `Editor*.(hpp|cpp)` files from engine to here.
+ - `.common`: Vendored libraries.
+- `brussel.codegen`
+ - `.comp`: Code generator similar to Qt MOC.
+ - `.rt`: Code that's consumed along with output of `brussel.codegen.comp`.
+- `brussel.game`: The main game.
- `assets`: The assets for the main game.
# History