File tree Expand file tree Collapse file tree 1 file changed +8
-6
lines changed
Expand file tree Collapse file tree 1 file changed +8
-6
lines changed Original file line number Diff line number Diff line change @@ -70,13 +70,15 @@ ctest --preset gcc-Sanitize
7070### Code Style and Linting
7171
7272This 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
108110Documentation 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
112114cmake --preset gcc-RelWithDebInfo
113115cmake --build --preset gcc-RelWithDebInfo --target docs
You can’t perform that action at this time.
0 commit comments