diff --git a/profile/README.md b/profile/README.md index d322c64..a43e203 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,39 +1,69 @@

- cpp-linter_brand_logo + cpp-linter brand logo

+

+ Automated C/C++ linting and formatting for your CI/CD pipelines and local workflows. +

+ +

+ Documentation + License: MIT + GitHub stars +

+ +--- + +## πŸ“– About + +**cpp-linter** bundles the power of `clang-format`, `clang-tidy`, and other LLVM tools into packages that are easy to install, integrate, and maintain. Whether you’re linting a single file locally or enforcing code quality across dozens of repos in CI, cpp-linter has you covered. + +We target C/C++ developers and DevOps engineers who want **reliable clang tooling without the build-from-source headache**. + --- -## Cpp Linter +## πŸš€ Get Started -[![Website](https://img.shields.io/static/v1?label=Website&message=cpp-linter.github.io&color=yellow)](https://cpp-linter.github.io/) +Integrate cpp-linter into your workflow in minutes: -### Get Started +- **[cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)** β€” GitHub Action that runs `clang-format` and `clang-tidy` on PRs and pushes, posting inline annotations. +- **[cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks)** β€” [pre-commit](https://pre-commit.com/) hooks for local development β€” catch issues before they hit CI. -Integrate Cpp Linter into your workflow with: +--- -* [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action) β€” GitHub Action for CI pipelines -* [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) β€” Pre-commit hooks for local development +## πŸ”§ Clang Tools β€” Simplified -### Clang Tools β€” Simplified +We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key clang tools: -We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key `clang-tools`: +| Package | Description | +|---------|-------------| +| [clang-tools-static-binaries](https://github.com/cpp-linter/clang-tools-static-binaries) | Statically-linked `clang-format`, `clang-tidy`, `clang-query`, and `clang-apply-replacements` binaries | +| [clang-tools-docker](https://github.com/cpp-linter/clang-tools-docker) | Docker images with pre-installed `clang-format` and `clang-tidy` | +| [clang-tools-wheel](https://github.com/cpp-linter/clang-tools-wheel) | Redistribute `clang-format` and `clang-tidy` Python wheels | -* [clang-tools-static-binaries](https://github.com/cpp-linter/clang-tools-static-binaries) -* [clang-tools-docker](https://github.com/cpp-linter/clang-tools-docker) -* [clang-tools-wheel](https://github.com/cpp-linter/clang-tools-wheel) +--- -### Easy Installation +## πŸ“¦ Easy Installation Prefer modern package managers? Install `clang-format`, `clang-tidy`, `clang-query`, and more via: -* [pip](https://github.com/cpp-linter/clang-tools-pip) -* [asdf](https://github.com/cpp-linter/asdf-clang-tools) +- **[pip](https://github.com/cpp-linter/clang-tools-pip)** β€” `pip install clang-tools` +- **[asdf](https://github.com/cpp-linter/asdf-clang-tools)** β€” `asdf plugin add clang-tools https://github.com/cpp-linter/asdf-clang-tools` + +--- + +## 🀝 Contributing + +We welcome contributions of all kinds β€” bug reports, feature requests, documentation improvements, and code. -## Contributing πŸ’ͺ +- πŸ“‹ Read our [Code of Conduct](https://github.com/cpp-linter/.github/blob/main/CODE_OF_CONDUCT.md) +- πŸ”§ Check individual repos for their `CONTRIBUTING.md` guides +- πŸ’¬ Join the discussion on [GitHub Discussions](https://github.com/orgs/cpp-linter/discussions) -Thanks for your interest in contributing to [cpp-linter](https://github.com/cpp-linter)! +--- -We welcome feedback, bug reports, and feature requests from the community! +

+ Made with ❀️ by the cpp-linter community +