Skip to content

Commit afc955b

Browse files
committed
docs: add FAQ section
1 parent d7c3023 commit afc955b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ A powerful [pre-commit](https://pre-commit.com/) hook for auto-formatting and li
1919
- [Troubleshooting](#troubleshooting)
2020
- [Performance Optimization](#performance-optimization)
2121
- [Verbose Output](#verbose-output)
22+
- [FAQ](#faq)
23+
- [What's the difference between `cpp-linter-hooks` and `mirrors-clang-format`?](#whats-the-difference-between-cpp-linter-hooks-and-mirrors-clang-format)
2224
- [Contributing](#contributing)
2325
- [License](#license)
2426

@@ -181,6 +183,19 @@ repos:
181183
args: [--style=file, --version=18, --verbose] # Add -v or --verbose for detailed output
182184
```
183185

186+
## FAQ
187+
188+
### What's the difference between [`cpp-linter-hooks`](https://github.com/cpp-linter/cpp-linter-hooks) and [`mirrors-clang-format`](https://github.com/pre-commit/mirrors-clang-format)?
189+
190+
| Feature | [`cpp-linter-hooks`](https://github.com/cpp-linter/cpp-linter-hooks) | [`mirrors-clang-format`](https://github.com/pre-commit/mirrors-clang-format) |
191+
|----------------------------------|:---------------------------------------------------------------------:|:----------------------------------------------------------------------------:|
192+
| Supports `clang-format` and `clang-tidy` | ✅ (`clang-format` & `clang-tidy`) | ✅ (`clang-format` only) |
193+
| Loads style configuration | ✅ via `--version` | ✅ (default behavior) |
194+
| Specify `clang-format` version | ✅ via `--version` | ✅ via `rev` |
195+
| Supports passing code string | ✅ via `--style` | ❌ |
196+
| Verbose output | ✅ via `--verbose` | ❌ |
197+
198+
184199
## Contributing
185200

186201
We welcome contributions! Whether it's fixing issues, suggesting improvements, or submitting pull requests, your support is greatly appreciated.

0 commit comments

Comments
 (0)