Add Install and TUI Quickstart to the README#80
Open
MJohnson459 wants to merge 1 commit into
Open
Conversation
The README covered purpose, build-from-source, and dispatch internals but gave an end user no download-and-run path and no walkthrough of the human workflow. Add an Install section matching the cargo-dist release pipeline (#77): the prebuilt `voro-installer.sh` shell installer, the per-platform Release tarballs (x86_64 Linux, aarch64 macOS), and the from-source `cargo install --git` path. Note Voro is Unix-only and ships a single `voro` binary. Add a Quickstart that drives the TUI cockpit end-to-end — register a project, create a task (`n`/`N`), triage it (`⏎ triage`), dispatch (`d`/`D`), and review the diff (`o`/`g`, `⏎ review`). Keys are taken from the ui.rs footer legend and app.rs key handling; the return-path verbs are framed as the agent's interface, not the operator's. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NimpS2bBUqN6qFNBXGZfjx
MJohnson459
commented
Jul 13, 2026
| binary for your platform and drops it in Cargo's bin directory (`~/.cargo/bin`): | ||
|
|
||
| ```bash | ||
| curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ClachDev/Voro/releases/latest/download/voro-installer.sh | sh |
Contributor
Author
There was a problem hiding this comment.
Do we need all these args?
| To build and install from source instead: | ||
|
|
||
| ```bash | ||
| cargo install --git https://github.com/ClachDev/Voro voro |
Contributor
Author
There was a problem hiding this comment.
Assuming we push to crates this can be simplified
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Install and Quickstart sections to README.md.
Install: matches the cargo-dist release pipeline (#118/#77). Documents the prebuilt shell installer (curl … releases/latest/download/voro-installer.sh | sh, lands in ~/.cargo/bin), the per-platform Release tarballs (x86_64-unknown-linux-gnu, aarch64-apple-darwin) with checksums, and the from-source path (cargo install --git https://github.com/ClachDev/Voro voro). Notes Voro is Unix-only and ships a single voro binary.
Quickstart: a TUI-centred operator walkthrough — launch the cockpit with bare 'voro', then register a project (Projects screen, 'a'; weight via 0-5), create a task ('n' editor / 'N' planning session, body = the agent's prompt), triage it into the queue (⏎ triage), dispatch ('d' / 'D' agent pick), and review the result ('o' checkout / 'g' PR, ⏎ review, reject-with-note re-dispatches). Frames the return-path verbs (ask/done/propose) as the agent's interface, not the operator's, and links docs/agent-integration.md. No invented keys — all taken from the ui.rs footer legend and app.rs key handling; no 'skill' system described.
Existing sections (Design, Building, Releasing, Dispatching, License) are unchanged.
Verified: install command/URL and tarball triples against dist-workspace.toml and .github/workflows/release.yml; every named key against crates/voro/src/ui.rs (key_hints) and crates/voro/src/app.rs (on_key/enter_hint); CLI verbs against crates/voro/src/cli.rs. Docs-only change.