Skip to content

docs: add a cpp-linter badge section to the README #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shenxianpeng wants to merge 1 commit into from
Closed

docs: add a cpp-linter badge section to the README #511

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,23 @@ clang tools. Linux workflows that use a specific [`container`][gh-container-synt
packages installed first. [Required tools][tools-doc] lists them and the sources each runner
installs the clang tools from.

## Add a badge

Show that your project is linted with cpp-linter by adding this badge to your README:

[![C/C++ lint: cpp-linter](https://img.shields.io/badge/C%2FC%2B%2B%20lint-cpp--linter-ffc20a?labelColor=454a63)](https://github.com/cpp-linter/cpp-linter-action)

```markdown
[![C/C++ lint: cpp-linter](https://img.shields.io/badge/C%2FC%2B%2B%20lint-cpp--linter-ffc20a?labelColor=454a63)](https://github.com/cpp-linter/cpp-linter-action)
```

To also show the result of your own lint runs, add the status badge of the workflow from
[Quick start](#quick-start), replacing `OWNER/REPO` with your repository:

```markdown
[![cpp-linter](https://github.com/OWNER/REPO/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/OWNER/REPO/actions/workflows/cpp-linter.yml)
```

## Used by

Projects from these organizations run cpp-linter-action on their default branch:
Expand Down
Loading