Skip to content

docs(readme): document Bash 4 requirement, drop sudo from dry-run example #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
twistedmelonman merged 2 commits into from
Aug 17, 2026
Merged

docs(readme): document Bash 4 requirement, drop sudo from dry-run example #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e70b313
docs(readme): document Bash 4 requirement, drop sudo from dry-run exa…
Aug 17, 2026
82f9a08
Merge branch 'main' into claude/validate-v1.0.193-review
twistedmelonman Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ The mirror list is in [`mirrors.txt`](./mirrors.txt), updated monthly by a GitHu
## Requirements

- macOS 10.6+ (any version with `/etc/resolver` support)
- Bash 4.0 or newer, on your `PATH`. macOS ships Bash 3.2 at `/bin/bash`, which
lacks the `mapfile` builtin this script relies on. Install a current Bash with
`brew install bash`.
- `sudo` / root access (for install/uninstall only)
- `curl` and `python3` (both ship with macOS)

Expand Down Expand Up @@ -61,8 +64,8 @@ Options:
# Standard install / update (fetches latest mirrors.txt from GitHub)
sudo ./install.sh

# Preview what would change
sudo ./install.sh --dry-run
# Preview what would change (no root needed; --dry-run skips the root check)
./install.sh --dry-run

# Update mirrors.txt from Wikipedia, then install
./install.sh --update-mirrors && sudo ./install.sh --no-fetch
Expand Down
Loading