Skip to content

README for the release, and ADR-0003 - #50

Merged
JacobStephens2 merged 2 commits into
mainfrom
issue-36
Sep 25, 2026
Merged

JacobStephens2 merged 2 commits into
mainfrom
issue-36

Conversation

@JacobStephens2

@JacobStephens2 JacobStephens2 commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

Summary

Closes #36

README brought up to date for the 0.1.0 release, plus ADR-0003 recording the release decision.

 README.md
   What a Run does
     Status
-      walking skeleton … (except marking a draft ready) …
+      designed behaviour implemented; gaps in open issues
   Install
+    curl … thirdshift-installer.sh | sh   → ~/.local/bin, no Rust
+    cargo install thirdshift             (alternative for Rust users)
     Updating                             (thirdshift update; lists the other kinds of install)
+  Supported platforms                    (Rocky 9.8+, Ubuntu 24.04.3+, WSL2 + Ubuntu 24.04+, macOS Tahoe 26.5.2+ Apple Silicon)
   Prerequisites                          (claude, gh, git only)
-    The Rust toolchain
   Usage
+    update / version / help              (bare words only)
+  Building from source                   (Rust, cargo install --path ., system-wide install, python3 for tests)
+  Releasing                              (bump in a PR → merge → push v<version> tag)
 docs/adr/
+  0003-static-binaries-through-github-releases.md

ADR-0003 gives three reasons for choosing static musl binaries through dist GitHub Releases, mirrored to crates.io, over crates.io alone: installing needs no Rust, a glibc build won't run on Rocky 9, and the crate name is permanent once claimed. CONTEXT.md is unchanged.

Evidence

Docs only, with no code changes.

  • Before: the README's Status still said "walking skeleton … (except marking a draft ready)", Install was cargo install --path ., and Rust was a prerequisite.
    After: every acceptance criterion in README for the release, and ADR-0003 #36 is covered. The claims were checked against dist-workspace.toml, .github/workflows/release-smoke.yml, publish-crates.yml, src/main.rs (help text) and src/update.rs (refusal hints). cargo test passes in full.

Merge Danger

Door: two-way

Blast Radius: documentation

Only readers are affected. The Install section points at releases/latest/download/thirdshift-installer.sh, which only works after v0.1.0 is tagged (#38).

Unaddressed findings

Standards

Spec

  • "The Linux user" became "The user account" (not requested): macOS is now a supported platform, so "Linux user" would be wrong.

🤖 Generated with Claude Code

JacobStephens2 and others added 2 commits September 25, 2026 16:34
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@JacobStephens2
JacobStephens2 merged commit 91ac863 into main Sep 25, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README for the release, and ADR-0003

1 participant