Skip to content

Commit 73ead28

Browse files
authored
docs: add Homebrew tap as a new installation method (#33)
## Summary Add the [cpp-linter Homebrew tap](https://github.com/cpp-linter/homebrew-tap) as a new installation method in the Getting Started documentation. ## Changes - **docs/getting-started.md** — Added a Homebrew Tap card to the "Easy Installation" grid section, alongside the existing pip and asdf options. This shows users they can install clang-format, clang-tidy, clang-query, clang-apply-replacements, and clang-include-cleaner via Homebrew with no compilation required. ## Why The Homebrew tap provides pre-built static binaries for macOS users, making installation even easier for developers who prefer Homebrew as their package manager. cc @shenxianpeng
1 parent 23f9095 commit 73ead28

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

docs/getting-started.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,17 @@ We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** o
102102

103103
---
104104

105-
Standalone Python wheel for `clang-apply-replacements`
105+
Install `clang-apply-replacements` via pip — standalone Python wheel
106106

107-
[Download from →](https://github.com/cpp-linter/clang-apply-replacements){ .md-button .md-button--primary }
107+
[Install from PyPI ](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary }
108108

109109
- :fontawesome-brands-python: **clang-include-cleaner**
110110

111111
---
112112

113-
Standalone Python wheel for `clang-include-cleaner` — detects unused `#include` directives
113+
Install `clang-include-cleaner` via pip — detects unused `#include` directives
114114

115-
[Download from →](https://github.com/cpp-linter/clang-include-cleaner){ .md-button .md-button--primary }
115+
[Install from PyPI ](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary }
116116

117117
</div>
118118

@@ -136,4 +136,12 @@ We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** o
136136

137137
[Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
138138

139+
- :fontawesome-brands-apple: **Homebrew Tap**
140+
141+
---
142+
143+
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required
144+
145+
[Get started with Homebrew →](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary }
146+
139147
</div>

0 commit comments

Comments
 (0)