Skip to content

Commit 2baf3e7

Browse files
committed
chore: update README to v1.6.0 and remove outdated Requirements section
- Removed the Requirements section ("v1.5.0 and later requires Python 3.10+") since v1.5.0 is no longer current - Updated all cpp-linter-hooks version references from v1.5.0 to v1.6.0
1 parent 4619ff0 commit 2baf3e7

1 file changed

Lines changed: 9 additions & 14 deletions

File tree

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ comparison.
4040

4141
- [Why cpp-linter-hooks?](#why-cpp-linter-hooks)
4242
- [GitHub Actions? Try cpp-linter-action](#github-actions-try-cpp-linter-action)
43-
- [Requirements](#requirements)
4443
- [Quick Start](#quick-start)
4544
- [Custom Configuration Files](#custom-configuration-files)
4645
- [Custom Clang Tool Version](#custom-clang-tool-version)
@@ -58,18 +57,14 @@ comparison.
5857
- [Contributing](#contributing)
5958
- [License](#license)
6059

61-
## Requirements
62-
63-
`cpp-linter-hooks` v1.5.0 and later requires Python 3.10 or newer.
64-
6560
## Quick Start
6661

6762
Add this configuration to your `.pre-commit-config.yaml` file:
6863

6964
```yaml
7065
repos:
7166
- repo: https://github.com/cpp-linter/cpp-linter-hooks
72-
rev: v1.5.0 # Use the tag or commit you want
67+
rev: v1.6.0 # Use the tag or commit you want
7368
hooks:
7469
- id: clang-format
7570
args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit.
@@ -84,7 +79,7 @@ To use custom configurations like `.clang-format` and `.clang-tidy`:
8479
```yaml
8580
repos:
8681
- repo: https://github.com/cpp-linter/cpp-linter-hooks
87-
rev: v1.5.0
82+
rev: v1.6.0
8883
hooks:
8984
- id: clang-format
9085
args: [--style=file] # Loads style from .clang-format file
@@ -93,7 +88,7 @@ repos:
9388
```
9489

9590
> [!TIP]
96-
> The `rev` tag (e.g. `v1.5.0`) is the **project** version, not the clang tool version. Each release bundles a default version of `clang-format` and `clang-tidy` — check the [release notes](https://github.com/cpp-linter/cpp-linter-hooks/releases) to see which tool version a given `rev` ships with. To pin an exact tool version independently of the project release, use `--version` as shown below.
91+
> The `rev` tag (e.g. `v1.6.0`) is the **project** version, not the clang tool version. Each release bundles a default version of `clang-format` and `clang-tidy` — check the [release notes](https://github.com/cpp-linter/cpp-linter-hooks/releases) to see which tool version a given `rev` ships with. To pin an exact tool version independently of the project release, use `--version` as shown below.
9792

9893
### Custom Clang Tool Version
9994

@@ -102,7 +97,7 @@ To use specific versions of clang-format and clang-tidy (using Python wheel pack
10297
```yaml
10398
repos:
10499
- repo: https://github.com/cpp-linter/cpp-linter-hooks
105-
rev: v1.5.0
100+
rev: v1.6.0
106101
hooks:
107102
- id: clang-format
108103
args: [--style=file, --version=21] # Specifies version
@@ -126,7 +121,7 @@ automatically — no configuration needed for most projects:
126121
```yaml
127122
repos:
128123
- repo: https://github.com/cpp-linter/cpp-linter-hooks
129-
rev: v1.5.0
124+
rev: v1.6.0
130125
hooks:
131126
- id: clang-tidy
132127
args: [--checks=.clang-tidy]
@@ -241,7 +236,7 @@ Use -header-filter=.* to display errors from all non-system headers. Use -system
241236
```yaml
242237
repos:
243238
- repo: https://github.com/cpp-linter/cpp-linter-hooks
244-
rev: v1.5.0 # includes --fix support
239+
rev: v1.6.0 # includes --fix support
245240
hooks:
246241
- id: clang-tidy
247242
args: [--checks=.clang-tidy, --fix]
@@ -260,7 +255,7 @@ repos:
260255

261256
```yaml
262257
- repo: https://github.com/cpp-linter/cpp-linter-hooks
263-
rev: v1.5.0
258+
rev: v1.6.0
264259
hooks:
265260
- id: clang-format
266261
args: [--style=file, --version=21]
@@ -275,7 +270,7 @@ or `-j`:
275270

276271
```yaml
277272
- repo: https://github.com/cpp-linter/cpp-linter-hooks
278-
rev: v1.5.0
273+
rev: v1.6.0
279274
hooks:
280275
- id: clang-tidy
281276
args: [--checks=.clang-tidy, --version=21, --jobs=4]
@@ -304,7 +299,7 @@ This approach ensures that only modified files are checked, further speeding up
304299
```yaml
305300
repos:
306301
- repo: https://github.com/cpp-linter/cpp-linter-hooks
307-
rev: v1.5.0
302+
rev: v1.6.0
308303
hooks:
309304
- id: clang-format
310305
args: [--style=file, --version=21, --verbose] # Shows processed files

0 commit comments

Comments
 (0)