diff --git a/docs/getting-started.md b/docs/getting-started.md index a39f10f..6a1e9a0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -68,80 +68,89 @@ Select the method that best fits your development workflow: -## Clang Tools — Simplified +## Install the clang tools -We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools: +Need `clang-format`, `clang-tidy`, and friends without building LLVM from source? +Choose whichever fits your setup. + +### Package managers (recommended)
-- :fontawesome-brands-github: **clang-tools-static-binaries** +- :fontawesome-brands-python: **clang-tools-pip** --- - Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows + Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via static binaries or Python wheels using a single CLI - [Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary } + [Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary } -- :fontawesome-brands-docker: **clang-tools-docker** +- :fontawesome-brands-apple: **Homebrew Tap** --- - Docker images with pre-installed `clang-format` and `clang-tidy` + Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required - [Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary } + [Get started with Homebrew →](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary } -- :fontawesome-brands-python: **clang-tools-wheels** +- :fontawesome-brands-python: **clang-tools-asdf** --- - Redistribute `clang-format` and `clang-tidy` Python wheels + Easy installation of clang tools static binaries via asdf - [Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary } + [Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary } -- :fontawesome-brands-python: **clang-apply-replacements** +
+ +### Prebuilt binaries, Docker & wheels + +
+ +- :fontawesome-brands-github: **clang-tools-static-binaries** --- - Install `clang-apply-replacements` via pip — standalone Python wheel + Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows - [Install from PyPI →](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary } + [Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary } -- :fontawesome-brands-python: **clang-include-cleaner** +- :fontawesome-brands-docker: **clang-tools-docker** --- - Install `clang-include-cleaner` via pip — detects unused `#include` directives + Docker images with pre-installed `clang-format` and `clang-tidy` - [Install from PyPI →](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary } + [Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary } -
+- :fontawesome-brands-python: **clang-tools-wheels** -## Easy Installation + --- -
+ Redistribute `clang-format` and `clang-tidy` Python wheels -- :fontawesome-brands-python: **clang-tools-pip** + [Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary } - --- +
- Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via static binaries or Python wheels using a single CLI +### Standalone tools - [Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary } +
-- :fontawesome-brands-python: **clang-tools-asdf** +- :fontawesome-brands-python: **clang-apply-replacements** --- - Easy installation of clang tools static binaries via asdf + Install `clang-apply-replacements` via pip — standalone Python wheel - [Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary } + [Install from PyPI →](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary } -- :fontawesome-brands-apple: **Homebrew Tap** +- :fontawesome-brands-python: **clang-include-cleaner** --- - Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required + Install `clang-include-cleaner` via pip — detects unused `#include` directives - [Get started with Homebrew →](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary } + [Install from PyPI →](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary }