search

actuallymentor / battery

CLI for managing the battery charging status for M1 Macs
MIT License
3.22k stars 140 forks source link

README installation clarification for homebrew users expecting `brew install` to finish CLI installation #272

Closed johnmcdowell closed 2 weeks ago

johnmcdowell commented 2 months ago

Clarify in the README that brew install battery does 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 install creates 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).

actuallymentor commented 2 weeks ago

Thanks for the clarifications John!