heavy-duty/rig
7
0
Fork 1
Code Issues 10 Pull requests Projects Releases 3 Packages Wiki Activity Actions

docs: align README quick start with main #91

Merged
codex-bot-andresmgsl merged 3 commits from fix/issue-89-readme-channel into main 2026-07-20 18:41:13 +00:00
Conversation 2 Commits 3 Files changed 2 +11 -5
2 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 491055c4cf - Show all commits

8
README.md
View file

@ -20,12 +20,14 @@ curl -fsSL https://raw.githubusercontent.com/heavy-duty/rig/main/install.sh | RI
This README tracks `main`, so the quick start installs that same development This README tracks `main`, so the quick start installs that same development
tree. To install a stable version instead, use the latest-release or pinned-tag tree. To install a stable version instead, use the latest-release or pinned-tag
channel and follow the documentation shipped with that version. Three channels channel and read the documentation shipped with it at
come from the same script; `RIG_REF` picks: `$RIG_HOME/current/README.md` (`~/.local/share/rig/current/README.md` with the
default install root). Three channels come from the same script; `RIG_REF`
picks:
```sh ```sh
curl -fsSL .../install.sh | bash # the latest release curl -fsSL .../install.sh | bash # the latest release
curl -fsSL .../install.sh | RIG_REF=0.1.0 bash # pinned to a release curl -fsSL .../install.sh | RIG_REF=0.2.0 bash # pinned to a release
curl -fsSL .../install.sh | RIG_REF=main bash # the development tree curl -fsSL .../install.sh | RIG_REF=main bash # the development tree
``` ```

8
test/cli.sh
View file

@ -438,8 +438,12 @@ check "README: no stale pre-0.1.0 release notice" 1 "" \
grep -qF 'Until rig cuts 0.1.0' "$ROOT/README.md" grep -qF 'Until rig cuts 0.1.0' "$ROOT/README.md"
check "README: still documents the latest-release channel" 0 "" \ check "README: still documents the latest-release channel" 0 "" \
grep -qF 'curl -fsSL .../install.sh | bash # the latest release' "$ROOT/README.md" grep -qF 'curl -fsSL .../install.sh | bash # the latest release' "$ROOT/README.md"
check "README: still documents the pinned-tag channel" 0 "" \ # $RIG_HOME is the literal path spelling the README must show operators.
grep -qF 'curl -fsSL .../install.sh | RIG_REF=0.1.0 bash # pinned to a release' "$ROOT/README.md" # shellcheck disable=SC2016
check "README: names the stable channel's installed documentation" 0 "" \
grep -qF '$RIG_HOME/current/README.md' "$ROOT/README.md"
check "README: still documents a pinned semver-tag channel" 0 "" \
grep -Eq '^curl -fsSL \.\.\./install\.sh \| RIG_REF=[0-9]+\.[0-9]+\.[0-9]+ bash +# pinned to a release$' "$ROOT/README.md"
# --- README: the box rename (#12) -------------------------------------------- # --- README: the box rename (#12) --------------------------------------------
# The philosophy line must point at heavy-duty/box — the old claudebox slug # The philosophy line must point at heavy-duty/box — the old claudebox slug