Skip to content

Commit 0549980

Browse files
committed
chore: update getting-started docs with new tools and features
- Add clang-include-cleaner to clang-tools-static-binaries description (LLVM 18+) - Add clang-apply-replacements and clang-include-cleaner standalone wheel cards - Rename section to 'Clang Tools — Simplified' for consistency - Update clang-tools-pip card to mention both binary and wheel support
1 parent daf7691 commit 0549980

2 files changed

Lines changed: 24 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ This repository hosts the public site at <https://cpp-linter.github.io/>, includ
1818

1919
- Project overview and landing page content
2020
- Getting started documentation
21+
- Clang tools distribution guides (static binaries, Docker images, Python wheels)
2122
- Discussion and community entry points

docs/getting-started.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,34 +68,52 @@ Select the method that best fits your development workflow:
6868

6969
</div>
7070

71-
## Clang Tools Distribution
71+
## Clang Tools — Simplified
72+
73+
We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools:
7274

7375
<div class="grid cards" markdown>
7476

7577
- :fontawesome-brands-github: **clang-tools-static-binaries**
7678

7779
---
7880

79-
Distribution clang tools static binaries for various platforms
81+
Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows
8082

8183
[Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary }
8284

8385
- :fontawesome-brands-docker: **clang-tools-docker**
8486

8587
---
8688

87-
Distribution clang tools Docker images for various platforms
89+
Docker images with pre-installed `clang-format` and `clang-tidy`
8890

8991
[Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary }
9092

9193
- :fontawesome-brands-python: **clang-tools-wheels**
9294

9395
---
9496

95-
Distribution clang tools Python wheels for various platforms
97+
Redistribute `clang-format` and `clang-tidy` Python wheels
9698

9799
[Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
98100

101+
- :fontawesome-brands-python: **clang-apply-replacements**
102+
103+
---
104+
105+
Standalone Python wheel for `clang-apply-replacements`
106+
107+
[Download from →](https://github.com/cpp-linter/clang-apply-replacements){ .md-button .md-button--primary }
108+
109+
- :fontawesome-brands-python: **clang-include-cleaner**
110+
111+
---
112+
113+
Standalone Python wheel for `clang-include-cleaner` — detects unused `#include` directives
114+
115+
[Download from →](https://github.com/cpp-linter/clang-include-cleaner){ .md-button .md-button--primary }
116+
99117
</div>
100118

101119
## Easy Installation
@@ -106,7 +124,7 @@ Select the method that best fits your development workflow:
106124

107125
---
108126

109-
Easy installation of clang tools static binaries via pip
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
110128

111129
[Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
112130

0 commit comments

Comments
 (0)