Skip to content

docs: Add Homebrew installation instructions#4

Open
Efan404 wants to merge 1 commit intowxtsky:mainfrom
Efan404:main
Open

docs: Add Homebrew installation instructions#4
Efan404 wants to merge 1 commit intowxtsky:mainfrom
Efan404:main

Conversation

@Efan404
Copy link
Copy Markdown

@Efan404 Efan404 commented Apr 6, 2026

Summary

This PR adds Homebrew installation instructions to the README, making it easier for macOS users to install CodeIsland.

Installation via Homebrew

brew tap efan404/codeisland
brew install --cask codeisland

Notes

Checklist

  • Added Homebrew installation as the recommended method
  • Preserved existing download instructions as alternative
  • Installation method is clearly documented

Copilot AI review requested due to automatic review settings April 6, 2026 14:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Homebrew-based installation instructions to the main README to make macOS installs simpler, and reorders the Installation section so Homebrew is the recommended path.

Changes:

  • Add a new “Homebrew (Recommended)” installation section with brew tap + brew install --cask commands
  • Downgrade the existing “Download” method to a non-recommended alternative by removing “(Recommended)” from its heading

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +55 to +60
### Homebrew (Recommended)

```bash
brew tap efan404/codeisland
brew install --cask codeisland
```
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

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

The PR description calls out that this tap is community-maintained and links to https://github.com/Efan404/homebrew-codeisland, but the README Homebrew section doesn’t mention that context. Consider adding a short note + link under the commands so users understand it’s not an official tap and know where to report tap issues.

Copilot uses AI. Check for mistakes.
Comment on lines +55 to +59
### Homebrew (Recommended)

```bash
brew tap efan404/codeisland
brew install --cask codeisland
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

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

README has a linked Simplified Chinese version (README.zh-CN.md) whose installation section still marks “Download” as recommended and doesn’t include the new Homebrew option. To keep bilingual docs consistent, consider updating the Chinese README (or adding a brief note here) so macOS users get the same recommended install path regardless of language.

Copilot uses AI. Check for mistakes.
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.

2 participants