From 05499809d3e6aaacfd8cc23fdbec7d8bcf90478d Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 15 Jun 2026 22:59:14 +0300 Subject: [PATCH 1/3] chore: update getting-started docs with new tools and features MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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 --- README.md | 1 + docs/getting-started.md | 28 +++++++++++++++++++++++----- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 13cb52d..05d3b30 100644 --- a/README.md +++ b/README.md @@ -18,4 +18,5 @@ This repository hosts the public site at , includ - Project overview and landing page content - Getting started documentation +- Clang tools distribution guides (static binaries, Docker images, Python wheels) - Discussion and community entry points diff --git a/docs/getting-started.md b/docs/getting-started.md index 7aaf3e5..14a9ffa 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -68,7 +68,9 @@ Select the method that best fits your development workflow: -## Clang Tools Distribution +## Clang Tools — Simplified + +We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools:
@@ -76,7 +78,7 @@ Select the method that best fits your development workflow: --- - Distribution clang tools static binaries for various platforms + Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows [Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary } @@ -84,7 +86,7 @@ Select the method that best fits your development workflow: --- - Distribution clang tools Docker images for various platforms + Docker images with pre-installed `clang-format` and `clang-tidy` [Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary } @@ -92,10 +94,26 @@ Select the method that best fits your development workflow: --- - Distribution clang tools Python wheels for various platforms + Redistribute `clang-format` and `clang-tidy` Python wheels [Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary } +- :fontawesome-brands-python: **clang-apply-replacements** + + --- + + Standalone Python wheel for `clang-apply-replacements` + + [Download from →](https://github.com/cpp-linter/clang-apply-replacements){ .md-button .md-button--primary } + +- :fontawesome-brands-python: **clang-include-cleaner** + + --- + + Standalone Python wheel for `clang-include-cleaner` — detects unused `#include` directives + + [Download from →](https://github.com/cpp-linter/clang-include-cleaner){ .md-button .md-button--primary } +
## Easy Installation @@ -106,7 +124,7 @@ Select the method that best fits your development workflow: --- - Easy installation of clang tools static binaries via pip + Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via static binaries or Python wheels using a single CLI [Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary } From 2f8730cbcab57bea2a5380c4834cee1881adeca0 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Wed, 17 Jun 2026 19:00:16 +0300 Subject: [PATCH 2/3] docs: add Homebrew tap installation method to getting-started page --- docs/getting-started.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 14a9ffa..e1f7d21 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -136,4 +136,12 @@ We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** o [Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary } +- :fontawesome-brands-apple: **Homebrew Tap** + + --- + + Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required + + [Get started with Homebrew →](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary } + From a26d7b7736340c86512eca11a944e850e76acbfa Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Wed, 17 Jun 2026 19:02:11 +0300 Subject: [PATCH 3/3] docs: point clang-apply-replacements and clang-include-cleaner to PyPI instead of GitHub repos --- docs/getting-started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index e1f7d21..a39f10f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -102,17 +102,17 @@ We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** o --- - Standalone Python wheel for `clang-apply-replacements` + Install `clang-apply-replacements` via pip — standalone Python wheel - [Download from →](https://github.com/cpp-linter/clang-apply-replacements){ .md-button .md-button--primary } + [Install from PyPI →](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary } - :fontawesome-brands-python: **clang-include-cleaner** --- - Standalone Python wheel for `clang-include-cleaner` — detects unused `#include` directives + Install `clang-include-cleaner` via pip — detects unused `#include` directives - [Download from →](https://github.com/cpp-linter/clang-include-cleaner){ .md-button .md-button--primary } + [Install from PyPI →](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary }