Skip to content

Commit e8e569a

Browse files
committed
Update README.md
1 parent 62bea9b commit e8e569a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,15 @@ ctest --preset gcc-Sanitize
7070
### Code Style and Linting
7171

7272
This project uses:
73-
- `.clang-format` for formatting (enforced via pre-commit)
74-
- `.clang-tidy` for linting (static analysis)
73+
- `.clang-format` for formatting (enforced via pre-commit hook)
74+
- `.clang-tidy` for static analysis (linting)
7575

76-
Run manually:
76+
If `clang-format` or `clang-tidy` is not found, the corresponding target will be skipped with a warning.
77+
78+
Run checks manually using custom CMake targets:
7779
```bash
78-
clang-format -i src/*.cpp include/**/*.hpp tests/*.cpp
79-
clang-tidy src/*.cpp -p build/gcc-RelWithDebInfo
80+
cmake --build --preset gcc-RelWithDebInfo --target clang-format
81+
cmake --build --preset gcc-RelWithDebInfo --target clang-tidy
8082
```
8183

8284
### Installation
@@ -107,7 +109,7 @@ cmake -DCMAKE_PREFIX_PATH=/path/to/install ..
107109

108110
Documentation is generated using [Doxygen](https://www.doxygen.nl). Docs are built from `Doxyfile`, with output in `docs/html/`.
109111

110-
Generate docs locally:
112+
Generate docs locally via custom CMake target:
111113
```bash
112114
cmake --preset gcc-RelWithDebInfo
113115
cmake --build --preset gcc-RelWithDebInfo --target docs

0 commit comments

Comments
 (0)