From f63fc9e339d7e47c805ee7738010a4b009947da6 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Mon, 14 Oct 2024 09:11:56 +0200 Subject: [PATCH] docs: add `ENABLE_CLANG_TIDY` to BUILD.md --- BUILD.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/BUILD.md b/BUILD.md index 657058edd2..99b372a30c 100644 --- a/BUILD.md +++ b/BUILD.md @@ -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.