README installation clarification for homebrew users expecting brew install to finish CLI installation#272
Merged
actuallymentor merged 3 commits intoactuallymentor:mainfrom Jun 28, 2024
Conversation
6 tasks
Owner
|
Thanks for the clarifications John! |
panoskava
pushed a commit
to panoskava/battery
that referenced
this pull request
Mar 17, 2026
…l-clarification README installation clarification for homebrew users expecting `brew install` to finish CLI installation
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
2 participants
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.
Clarify in the README that
brew install batterydoes not alone completely install the command line tools.I expected brew to complete the installation of the command line tools. I couldn't locate the tools anywhere. The README didn't explain clearly that
brew installcreates a macOS app that must be run to complete the command line installation.I expect many others familiar with typical projects manageable with homebrew to have the same confusion. I made very small edits on two lines in the README to address the confusion.
The homebrew cask could separately be updated to be clearer that it's not just the CLI and that the app needs to be run.
I also fixed a small vscode setting for eslint that has been deprecated since vscode 1.85 (November 2023).