Skip to content

Expand README with repo layout and setup steps #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sid-rl wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −1
Open

Expand README with repo layout and setup steps #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# sandbox
# 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
```
Loading