added readme's

2026-10-06 01:24:16 -07:00
parent 0f0b0d1434
commit bfc96bac2b
2 changed files with 28 additions and 0 deletions
@@ -0,0 +1,15 @@
+# sandbox
+
+A playground for working out the implementation and architecture of new engine features. It can include the engine's internal backend headers (`engine/src`) as well as the public API, so you can use classes such as `Device`, `RenderContext`, `RenderGraph` and `SceneRenderer` directly.
+
+Prototype a feature here first. Once its design settles, move it into the engine and expose it through the public API, which [testbed](../testbed/README.md) exercises.
+
+Any `.cpp` file in this directory is compiled in automatically.
+
+## Running
+
+```sh
+dev sandbox [args...]
+```
+
+This builds the `debug` preset and runs `build/debug/bin/sandbox`. Shaders are loaded from `shaders/` (`SANDBOX_SHADER_DIR`).