Skip to content

docs: README install section reflects published release v0.1.1 - #239

Merged
mcmullarkey merged 2 commits into
mainfrom
readme-release-note
Sep 9, 2026
Merged

mcmullarkey merged 2 commits into
mainfrom
readme-release-note

Conversation

@mcmullarkey

Copy link
Copy Markdown
Owner

Summary

Release v0.1.1 is published with 5 assets (4 tarballs + sha256sums.txt) and the curl | sh install one-liner was verified end-to-end (blendtutor 0.1.1). The README install section still carried the stale caveat "No release assets are published yet — until the next release, install from a clone". Replaced it with a link to the releases page (prebuilt binaries for Linux and macOS, x86_64 + aarch64); cargo install --path crates/cli kept as the build-from-source fallback.

Context

Release v0.1.1 published — install caveat now stale. Fast-track docs change (no plan ref).

Changes

  • README.md install section: caveat → releases-page link + cargo fallback (3 insertions, 3 deletions, 150 lines total — within the ≤150 concision ceiling)

Pin-test audit (before editing)

  • scripts/tests/test_quarto_distribution.sh — no caveat/curl/releases pin
  • scripts/tests/test_demo_docs.sh — c9 region band (60–149) and c12 ceiling (≤150) unaffected (same 7-for-7 line swap; demo-book URL stays at line 119)
  • crates/cli/tests/readme.rs — pins ("binary install", "cargo install"); cargo install retained

Test plan

  • bash scripts/tests/test_quarto_distribution.sh — 91 passed
  • bash scripts/tests/test_demo_docs.sh — 22 passed
  • cargo test -p blendtutor-cli --test readme — 1 passed
  • wc -l README.md — 150 ≤ 150

Release v0.1.1 is published with prebuilt binaries (Linux + macOS,
x86_64 + aarch64) and the curl | sh one-liner is verified end-to-end.
The 'no release assets are published yet' caveat is stale — replace it
with a link to the releases page and keep cargo install as the
build-from-source fallback.
@mcmullarkey
mcmullarkey merged commit 11823a7 into main Sep 9, 2026
5 checks passed
@mcmullarkey
mcmullarkey deleted the readme-release-note branch September 9, 2026 03:13
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.

1 participant