Skip to content

docs(install): add Homebrew installation option#357

Merged
mchmarny merged 2 commits intomainfrom
docs/homebrew-install
Mar 11, 2026
Merged

docs(install): add Homebrew installation option#357
mchmarny merged 2 commits intomainfrom
docs/homebrew-install

Conversation

@mchmarny
Copy link
Member

@mchmarny mchmarny commented Mar 11, 2026

Summary

  • Add brew tap NVIDIA/aicr && brew install aicr as the primary installation method across all user-facing docs
  • Renumber existing options (Automated → Option 2, Manual → Option 3, Source → Option 4) in the installation guides
  • Updated files: README.md, docs/user/installation.md, docs/README.md, docs/user/README.md, demos/valid.md, and their site/ counterparts

Closes #355

Test plan

  • Verify Homebrew instructions render correctly on GitHub and the docs site
  • Confirm brew tap NVIDIA/aicr && brew install aicr works on a clean machine

Add `brew tap NVIDIA/aicr && brew install aicr` as the first
installation method across all user-facing documentation.
@mchmarny mchmarny requested a review from a team as a code owner March 11, 2026 22:21
@mchmarny mchmarny self-assigned this Mar 11, 2026
@mchmarny mchmarny added the enhancement New feature or request label Mar 11, 2026
@mchmarny mchmarny added this to the M1 - Repo Opening milestone Mar 11, 2026
@mchmarny mchmarny enabled auto-merge (squash) March 11, 2026 22:23
Copy link
Contributor

@yuanchen8911 yuanchen8911 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inconsistent Go version requirement between source docs and site docs.
- docs/user/installation.md:70 says Go 1.26 or higher.
- site/content/docs/user/installation.md:75 says Go 1.25 or higher.

@mchmarny
Copy link
Member Author

mchmarny commented Mar 11, 2026

inconsistent Go version requirement between source docs and site docs. - docs/user/installation.md:70 says Go 1.26 or higher. - site/content/docs/user/installation.md:75 says Go 1.25 or higher.

Ack, out of scope of this PR... this PR does not change any go versions though, does it?

@mchmarny mchmarny merged commit c5a9115 into main Mar 11, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add homebrew install instructions

3 participants