aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorrtk0c <[email protected]>2023-09-20 23:58:58 -0700
committerrtk0c <[email protected]>2023-09-20 23:58:58 -0700
commitf138311d2d2e0cc9ba0496d523bb46f2c1c9fb73 (patch)
treef96100a813a4ffb28dcd074455d3a2f8ee426430 /README.md
Copy from the PlasticSCM repo, replace vendored glm wtih conan
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c779a04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Project Brussel
+
+## Utlilized Open Source Projects
++ [Ogre3D](https://www.ogre3d.org/): referenced a large number of classes and implementation
++ [Urho3D](https://urho3d.io/)
++ [godot](https://godotengine.org/)
++ Everything else in `3rdparty/`
+
+## 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.
+- `assets`: The assets for the main game.