Skip to content

Commit c730ea2

Browse files
shenxianpeng2bndy5
andauthored
Update README.md to inlcude other repos (#35)
* Update README.md to inlcude other repos * trim trailing whitespace * Update profile/README.md Co-authored-by: Brendan <2bndy5@gmail.com> --------- Co-authored-by: Brendan <2bndy5@gmail.com>
1 parent 7260035 commit c730ea2

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

profile/README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,32 @@
66

77
## Cpp Linter
88

9-
**Lint your C/C++ code in an automated workflow**
9+
<!-- markdownlint-disable MD036 -->
10+
**Automated linting for your C/C++ code**
1011

11-
Including analysis regarding code formatting, diagnosing, and fixing typical programming errors.
12+
### Get Started
1213

13-
Wonder how to get started? check out:
14+
Integrate Cpp Linter into your workflow with:
1415

15-
* [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action) as a CI workflow step
16-
* [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) as a pre-commit workflow step
16+
* [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action) — GitHub Action for CI pipelines
17+
* [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) — Pre-commit hooks for local development
18+
19+
### Clang Tools — Simplified
20+
21+
We provide ready-to-use **binaries** and **Docker images** of key `clang-tools`:
22+
23+
* [clang-tools-static-binaries](https://github.com/cpp-linter/clang-tools-static-binaries)
24+
* [clang-tools-docker](https://github.com/cpp-linter/clang-tools-docker)
25+
26+
### Easy Installation
27+
28+
Prefer modern package managers? Install `clang-format`, `clang-tidy`, `clang-query`, and more via:
29+
30+
* [pip](https://github.com/cpp-linter/clang-tools-pip)
31+
* [asdf](https://github.com/cpp-linter/asdf-clang-tools)
1732

1833
## Contributing 💪
1934

20-
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!
35+
Thanks for your interest in contributing to [cpp-linter](https://github.com/cpp-linter)!
36+
37+
We welcome feedback, bug reports, and feature requests from the community!

0 commit comments

Comments
 (0)