diff --git a/README.md b/README.md index 73e0d12..6c453fd 100644 --- a/README.md +++ b/README.md @@ -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 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 -come from the same script; `RIG_REF` picks: +channel and read the documentation shipped with it at +`$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 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 ``` diff --git a/test/cli.sh b/test/cli.sh index a2173d7..a0af5ab 100644 --- a/test/cli.sh +++ b/test/cli.sh @@ -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" check "README: still documents the latest-release channel" 0 "" \ grep -qF 'curl -fsSL .../install.sh | bash # the latest release' "$ROOT/README.md" -check "README: still documents the pinned-tag channel" 0 "" \ - grep -qF 'curl -fsSL .../install.sh | RIG_REF=0.1.0 bash # pinned to a release' "$ROOT/README.md" +# $RIG_HOME is the literal path spelling the README must show operators. +# 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) -------------------------------------------- # The philosophy line must point at heavy-duty/box — the old claudebox slug