Skip to content

🍺 [readme] document brew install - #50

Merged
chicks-net merged 1 commit into
mainfrom
chicks/2026-09-13-readme-brew
Sep 13, 2026
Merged

chicks-net merged 1 commit into
mainfrom
chicks/2026-09-13-readme-brew

Conversation

@chicks-net

Copy link
Copy Markdown
Owner

Done

  • 🍺 [readme] document brew install

Meta

(Automated in .just/gh-process.just.)

Signed-off-by: Christopher Hicks <chicks.net@gmail.com>
@claude

claude Bot commented Sep 13, 2026

Copy link
Copy Markdown

Reviewed — this is a small, low-risk documentation-only change (README.md, +13/-4). Overall it reads well and the cleanup (removing the now-resolved homebrew-chicks#74 "coming soon" bullet) is a nice touch.

A few notes:

Accuracy to double-check

  • The line "on other platforms it falls back to building from source with go" is a specific behavioral claim about the chicks-net/chicks tap formula. Worth confirming the formula actually has an on_macos/on_linux/source-build fallback stanza for unsupported platforms (e.g. non-amd64/arm64 Linux) before merging, so the README doesn't overpromise. If the formula is bottle-only with no source fallback, this line should be adjusted.
  • Tap coordinates chicks-net/chicks/ctm imply a chicks-net/homebrew-chicks tap repo with an ctm formula — this matches the repo referenced in the removed issue link, so naming looks consistent, but it's worth a quick brew install chicks-net/chicks/ctm smoke test on a real machine (or CI) if that hasn't already been done, since a broken install command in the README is worse than no install command.

Minor

  • "I'd like to get this into Debian eventually too" reads a bit oddly right after the Homebrew instructions — might flow better as its own short paragraph or folded into a "Coming soon" bullet in the Status section for consistency with how the Homebrew item was tracked before, but this is a style nit, not a blocker.

Testing/CI

  • No code changes, so no test coverage concerns — just test/just fmt shouldn't be affected. Might be worth running just markdown lint (markdownlint-cli2) locally if not already covered by CI, just to catch any formatting nits in the new code fences.

No security or performance concerns — this is documentation-only. Nice, focused change overall.

@chicks-net
chicks-net merged commit c184c1b into main Sep 13, 2026
11 checks passed
@chicks-net
chicks-net deleted the chicks/2026-09-13-readme-brew branch September 13, 2026 20:18
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