diff --git a/README.md b/README.md index a2416fa..f34f275 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -# sandbox \ No newline at end of file +# sandbox + +A scratch repo for experiments. + +## Layout + +| Path | Contents | +| --- | --- | +| `main.py` | Minimal entry point. | +| `runloop_api/` | Scripts against the Runloop API — creating blueprints, running and scoring scenarios, running benchmarks, shutting down devboxes. | +| `app/` | Node todo app from the Docker getting-started tutorial, with `docker-compose.yml`. | +| `docker/` | Standalone Dockerfile experiments. | +| `docs/` | Sphinx docs, published to GitHub Pages by `.github/workflows/sphinx.yml`. | + +## Getting started + +Requires Python 3.12+ and [uv](https://docs.astral.sh/uv/). + +```bash +uv sync +uv run main.py +``` + +## Docs + +```bash +uv run sphinx-build docs docs/_build +```