Skip to content

Commit

Permalink
docs: add ENABLE_CLANG_TIDY to BUILD.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vikman90 committed Oct 14, 2024
1 parent 4d5f606 commit f63fc9e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,13 @@ The following dependencies are required for this project:
ctest --test-dir build --output-log build
```

### Options

|Option|Description|Default|
|---|---|---|
|`BUILD_TESTS`|Enable tests compilation||
|`ENABLE_CLANG_TIDY`|Check code with _clang-tidy_|`OFF`|

## Notes

- The project uses `vcpkg` as a submodule to manage dependencies. By initializing the submodules, `vcpkg` will automatically fetch the necessary dependencies when running CMake.

0 comments on commit f63fc9e

Please sign in to comment.