Skip to content

Commit 07c8a1b

Browse files
authored
docs(getting-started): merge overlapping clang-tools install sections (#49)
1 parent 7a7b814 commit 07c8a1b

1 file changed

Lines changed: 39 additions & 30 deletions

File tree

docs/getting-started.md

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -68,80 +68,89 @@ Select the method that best fits your development workflow:
6868

6969
</div>
7070

71-
## Clang Tools — Simplified
71+
## Install the clang tools
7272

73-
We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools:
73+
Need `clang-format`, `clang-tidy`, and friends without building LLVM from source?
74+
Choose whichever fits your setup.
75+
76+
### Package managers (recommended)
7477

7578
<div class="grid cards" markdown>
7679

77-
- :fontawesome-brands-github: **clang-tools-static-binaries**
80+
- :fontawesome-brands-python: **clang-tools-pip**
7881

7982
---
8083

81-
Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows
84+
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via static binaries or Python wheels using a single CLI
8285

83-
[Download from ](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary }
86+
[Get started with clang-tools CLI ](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
8487

85-
- :fontawesome-brands-docker: **clang-tools-docker**
88+
- :fontawesome-brands-apple: **Homebrew Tap**
8689

8790
---
8891

89-
Docker images with pre-installed `clang-format` and `clang-tidy`
92+
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required
9093

91-
[Download from ](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary }
94+
[Get started with Homebrew ](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary }
9295

93-
- :fontawesome-brands-python: **clang-tools-wheels**
96+
- :fontawesome-brands-python: **clang-tools-asdf**
9497

9598
---
9699

97-
Redistribute `clang-format` and `clang-tidy` Python wheels
100+
Easy installation of clang tools static binaries via asdf
98101

99-
[Download from ](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
102+
[Get started with asdf ](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
100103

101-
- :fontawesome-brands-python: **clang-apply-replacements**
104+
</div>
105+
106+
### Prebuilt binaries, Docker & wheels
107+
108+
<div class="grid cards" markdown>
109+
110+
- :fontawesome-brands-github: **clang-tools-static-binaries**
102111

103112
---
104113

105-
Install `clang-apply-replacements` via pip — standalone Python wheel
114+
Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows
106115

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

109-
- :fontawesome-brands-python: **clang-include-cleaner**
118+
- :fontawesome-brands-docker: **clang-tools-docker**
110119

111120
---
112121

113-
Install `clang-include-cleaner` via pip — detects unused `#include` directives
122+
Docker images with pre-installed `clang-format` and `clang-tidy`
114123

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

117-
</div>
126+
- :fontawesome-brands-python: **clang-tools-wheels**
118127

119-
## Easy Installation
128+
---
120129

121-
<div class="grid cards" markdown>
130+
Redistribute `clang-format` and `clang-tidy` Python wheels
122131

123-
- :fontawesome-brands-python: **clang-tools-pip**
132+
[Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
124133

125-
---
134+
</div>
126135

127-
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via static binaries or Python wheels using a single CLI
136+
### Standalone tools
128137

129-
[Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
138+
<div class="grid cards" markdown>
130139

131-
- :fontawesome-brands-python: **clang-tools-asdf**
140+
- :fontawesome-brands-python: **clang-apply-replacements**
132141

133142
---
134143

135-
Easy installation of clang tools static binaries via asdf
144+
Install `clang-apply-replacements` via pip — standalone Python wheel
136145

137-
[Get started with asdf ](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
146+
[Install from PyPI ](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary }
138147

139-
- :fontawesome-brands-apple: **Homebrew Tap**
148+
- :fontawesome-brands-python: **clang-include-cleaner**
140149

141150
---
142151

143-
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrewno compilation required
152+
Install `clang-include-cleaner` via pipdetects unused `#include` directives
144153

145-
[Get started with Homebrew ](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary }
154+
[Install from PyPI ](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary }
146155

147156
</div>

0 commit comments

Comments
 (0)