|
| 1 | +# Getting Started |
| 2 | + |
| 3 | +Welcome to cpp-linter! This guide will help you integrate C/C++ linting into your workflow quickly and efficiently. |
| 4 | + |
| 5 | +## Choose Your Integration |
| 6 | + |
| 7 | +Select the method that best fits your development workflow: |
| 8 | + |
| 9 | +<div class="grid cards" markdown> |
| 10 | + |
| 11 | +- :material-github: **GitHub Actions** |
| 12 | + |
| 13 | + --- |
| 14 | + |
| 15 | + GitHub Action for automated C/C++ linting in your workflows |
| 16 | + |
| 17 | + **Perfect for:** CI/CD pipelines, automated PRs, team collaboration |
| 18 | + |
| 19 | + [Get started with GitHub Actions →](https://cpp-linter.github.io/cpp-linter-action/){ .md-button .md-button--primary } |
| 20 | + |
| 21 | + |
| 22 | +- :material-git: **Pre-commit Hooks** |
| 23 | + |
| 24 | + --- |
| 25 | + |
| 26 | + Pre-commit hooks for automated C/C++ linting in your local development |
| 27 | + |
| 28 | + **Perfect for:** Catching issues before commits, local enforcement |
| 29 | + |
| 30 | + [Get started with pre-commit →](https://github.com/cpp-linter/cpp-linter-hooks){ .md-button .md-button--primary } |
| 31 | + |
| 32 | + |
| 33 | +- :fontawesome-brands-python: **Command Line** |
| 34 | + |
| 35 | + --- |
| 36 | + |
| 37 | + Core Python package for cpp-linter-action behind the scenes |
| 38 | + |
| 39 | + **Perfect for:** Local development, custom scripts, one-off analysis |
| 40 | + |
| 41 | + [Get started with cpp-linter package →](https://cpp-linter.github.io/cpp-linter/){ .md-button .md-button--primary } |
| 42 | + |
| 43 | +- :simple-rust: **Command Line (Rust)** |
| 44 | + |
| 45 | + --- |
| 46 | + |
| 47 | + High-performance Rust implementation of cpp-linter |
| 48 | + |
| 49 | + **Perfect for:** Local development, custom scripts, one-off analysis |
| 50 | + |
| 51 | + [Get started with cpp-linter-rs →](https://cpp-linter.github.io/cpp-linter-rs/){ .md-button .md-button--primary } |
| 52 | + |
| 53 | +</div> |
| 54 | + |
| 55 | +## Clang Tools Distribution |
| 56 | + |
| 57 | +<div class="grid cards" markdown> |
| 58 | + |
| 59 | +- :fontawesome-brands-binary: **clang-tools-static-binaries** |
| 60 | + |
| 61 | + --- |
| 62 | + |
| 63 | + Distribution clang tools static binaries for various platforms |
| 64 | + |
| 65 | + [Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary } |
| 66 | + |
| 67 | + |
| 68 | +- :fontawesome-brands-docker: **clang-tools-docker** |
| 69 | + |
| 70 | + --- |
| 71 | + |
| 72 | + Distribution clang tools Docker images for various platforms |
| 73 | + |
| 74 | + [Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary } |
| 75 | + |
| 76 | + |
| 77 | +- :fontawesome-brands-python: **clang-tools-wheels** |
| 78 | + |
| 79 | + --- |
| 80 | + |
| 81 | + Distribution clang tools Python wheels for various platforms |
| 82 | + |
| 83 | + [Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary } |
| 84 | + |
| 85 | +</div> |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +## Easy Installation |
| 90 | + |
| 91 | +<div class="grid cards" markdown> |
| 92 | + |
| 93 | +- :fontawesome-brands-python: **clang-tools-pip** |
| 94 | + |
| 95 | + --- |
| 96 | + |
| 97 | + Easy installation of clang tools static binaries via pip |
| 98 | + |
| 99 | + [Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary } |
| 100 | + |
| 101 | +- :fontawesome-brands-python: **clang-tools-asdf** |
| 102 | + |
| 103 | + --- |
| 104 | + |
| 105 | + Easy installation of clang tools static binaries via asdf |
| 106 | + |
| 107 | + [Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary } |
| 108 | + |
| 109 | +</div> |
0 commit comments