Skip to content

doc: add Homebrew (macOS) install instructions to README - #5354

Open
soloturn wants to merge 1 commit into
developfrom
docs/readme-homebrew-install
Open

doc: add Homebrew (macOS) install instructions to README#5354
soloturn wants to merge 1 commit into
developfrom
docs/readme-homebrew-install

Conversation

@soloturn

@soloturn soloturn commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

AI-assisted change proposal. Filed by agent driven by @soloturn via GDD.

Summary

Test plan

  • Verified both cask names/behavior against the actual tap: brew tap MovingBlocks/terasology, brew install terasology and brew install terasology-latest-bin both install a launchable .app plus terminal command, side-by-side capable, openjdk pulled in automatically

Related

MovingBlocks/homebrew-terasology (transferred from a personal fork, see #5351)
now provides two casks - terasology (pinned stable release) and
terasology-latest-bin (latest develop/Omega CI build) - but the README's
Alternative Installation Methods section never mentioned it, so macOS users
had no discoverable path to it beyond the direct-download zip.

Co-Authored-By: soloturn <soloturn@gmail.com>
@github-actions github-actions Bot added the Category: Doc Requests, Issues and Changes targeting javadoc and module documentation label Aug 1, 2026
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4cf35e0b-8611-46d5-82e7-7a8f9cd1c792

📥 Commits

Reviewing files that changed from the base of the PR and between 968904f and aadfcfa.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added macOS Homebrew installation instructions for stable and development builds.
    • Documented app and terminal command availability, side-by-side installation, and automatic Java installation.

Walkthrough

README.md adds macOS Homebrew instructions for stable and development Terasology builds. It documents the installed application, terminal command, side-by-side installation, and automatic openjdk installation.

Changes

macOS Homebrew Installation

Layer / File(s) Summary
Document Homebrew installation
README.md
Adds commands for stable and development builds. Documents Terasology.app, the terminal command, side-by-side installation, and automatic openjdk installation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

A rabbit taps a brew command bright,
Stable and nightly builds take flight.
Terasology.app rests in place,
With Java ready for the race.
Two builds sit side by side—
“Hop,” says the rabbit, “enjoy the ride!”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the README change that adds macOS Homebrew installation instructions.
Description check ✅ Passed The description directly explains the Homebrew documentation changes, commands, verification, and related tap ownership transfer.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-homebrew-install

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@BenjaminAmos

Copy link
Copy Markdown
Contributor

Before this can be considered, I think we need either a commitment from someone (including yourself) to maintain this tap in the long-term, or a more automated means of maintaining it ourselves. The preferred means of installation will remain the launcher, as it is consistent across all platforms and most macOS users are not expected to have Homebrew installed. It also creates a situation where, despite being largely a less supported platform, macOS gets preferential treatment for official packaging where Linux distributions do not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Category: Doc Requests, Issues and Changes targeting javadoc and module documentation

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants