Skip to content

docs: use brew for pre-commit install #4

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
Jason-Adam merged 1 commit into from
Mar 28, 2026
Merged

docs: use brew for pre-commit install #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To customize, run `vitals --init` to generate a config at `~/.config/vitals/conf

```bash
# Install pre-commit hooks
pip install pre-commit
brew install pre-commit
pre-commit install
Comment on lines 29 to 31
Copy link

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

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

brew install pre-commit is macOS/Homebrew-specific and will break setup for contributors on Linux/Windows (or macOS without Homebrew). Consider documenting multiple install options (e.g., Homebrew or pipx/pip install --user pre-commit) or linking to the official pre-commit installation docs so the README remains platform-agnostic.

Copilot uses AI. Check for mistakes.

# Run tests
Expand Down
Loading