docs: shorten the README - #3
Merged
Merged
Conversation
Keeps every command and every real caveat (self-signed app and the quarantine attribute, Apple silicon only, updates through brew, full uninstall first); drops the background explanations. The Chinese README is shortened in parallel. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Shortens README.md (104 → 65 lines) and README.zh-CN.md (in parallel) so the page leads with the install command and keeps only what a user needs.
Kept exactly: the install, upgrade, uninstall and
--zapcommands, and thexattrcommand the cask runs.Kept as caveats: self-signed (not Developer ID) signing and the quarantine attribute, the manual alternative, Open Anyway / macOS 15 Control-click change, Apple silicon and macOS 12+ only, no self-update for Homebrew installs,
brew updatebefore upgrading, Settings › Full uninstall before removing the app, what~/.thinkwatchholds.Dropped: the longer rationale (checksum provenance,
HOMEBREW_AUTO_UPDATE_SECS, why self-update would confuse Homebrew in detail).🤖 Generated with Claude Code