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 }