Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ This repository hosts the public site at <https://cpp-linter.github.io/>, 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
28 changes: 23 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,34 +68,52 @@ Select the method that best fits your development workflow:

</div>

## Clang Tools Distribution
## Clang Tools β€” Simplified

We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools:

<div class="grid cards" markdown>

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

---

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 }

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

---

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 }

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

---

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 }

</div>

## Easy Installation
Expand All @@ -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 }

Expand Down