From bfc96bac2b33d071928dc0c931cb40365524a1d5 Mon Sep 17 00:00:00 2001 From: Caleb Burke Date: Tue, 6 Oct 2026 01:24:16 -0700 Subject: [PATCH] added readme's --- sandbox/README.md | 15 +++++++++++++++ testbed/README.md | 13 +++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 sandbox/README.md create mode 100644 testbed/README.md diff --git a/sandbox/README.md b/sandbox/README.md new file mode 100644 index 0000000..288d04c --- /dev/null +++ b/sandbox/README.md @@ -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`). diff --git a/testbed/README.md b/testbed/README.md new file mode 100644 index 0000000..c896645 --- /dev/null +++ b/testbed/README.md @@ -0,0 +1,13 @@ +# testbed + +Exercises the engine's frontend API. It includes only the public headers in `engine/include/sophia/`, so it uses the engine the way a game would. + +Use it to check that public API changes work and feel right from the caller's side. It cannot include engine internals (`engine/src`). If something needs them, it belongs in [sandbox](../sandbox/README.md) instead. + +## Running + +```sh +dev testbed [args...] +``` + +This builds the `debug` preset and runs `build/debug/bin/testbed`. Shaders are loaded from `shaders/` (`TESTBED_SHADER_DIR`).