Skip to content

docs: add a Quick start section to README.md #408

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

Merged
ncrmro merged 2 commits into from
Sep 4, 2026
Merged

docs: add a Quick start section to README.md #408

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c87aa7
docs: add a Quick start section to README.md
ncrmro Sep 4, 2026
d115200
docs: reframe the section as the contributor path per review
ncrmro Sep 4, 2026
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ prototype.
New here? [`docs/overview.md`](docs/overview.md) explains how the pieces fit together: the
mental model behind the dashboard.

## Working on panopticon

Set up a dev environment and bring the stack up with `make sync`, then `make start`
(`make stop` tears it down). The full development loop — checks, base-image build,
migrations — is in [`docs/dev.md`](docs/dev.md); to *use* panopticon, see
[Install](#install) below.

## The dashboard

See the whole fleet in one terminal view, with every task's `state`, whose `turn` it is (agent or you),
Expand Down
Loading