Addition of documentation of clang-tidy activation in cmake

sjanel · May 4, 2022 · 623036c · 623036c
1 parent a6e621a
commit 623036c
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -79,8 +79,9 @@ Then, locate where curl is installed (by default, should be in `C:\ProgramData\c
 
 ### External libraries
 
-`coincenter` uses various external open source libraries. 
-In all cases, they do not need to be installed. If they are not found at configure time, `cmake` will fetch sources and compile them automatically. If you are building frequently `coincenter` you can install them to speed up its compilation.
+`coincenter` uses various external open source libraries.
+In all cases, they do not need to be installed. If they are not found at configure time, `cmake` will fetch sources and compile them automatically. 
+If you are building frequently `coincenter` you can install them to speed up its compilation.
 
 | Library                                                        | Description                                        | License              |
 | -------------------------------------------------------------- | -------------------------------------------------- | -------------------- |
@@ -104,11 +105,12 @@ Other compilers have not been tested yet.
 
 #### cmake build options
 
-| Option             | Default              | Description                                     |
-| ------------------ | -------------------- | ----------------------------------------------- |
-| `CCT_ENABLE_TESTS` | `ON` if main project | Build and launch unit tests                     |
-| `CCT_BUILD_EXEC`   | `ON` if main project | Build an executable instead of a static library |
-| `CCT_ENABLE_ASAN`  | `ON` if Debug mode   | Compile with AddressSanitizer                   |
+| Option                  | Default                                                | Description                                     |
+| ----------------------- | ------------------------------------------------------ | ----------------------------------------------- |
+| `CCT_ENABLE_TESTS`      | `ON` if main project                                   | Build and launch unit tests                     |
+| `CCT_BUILD_EXEC`        | `ON` if main project                                   | Build an executable instead of a static library |
+| `CCT_ENABLE_ASAN`       | `ON` if Debug mode                                     | Compile with AddressSanitizer                   |
+| `CCT_ENABLE_CLANG_TIDY` | `ON` if Debug mode and `clang-tidy` is found in `PATH` | Compile with clang-tidy checks                  |
 
 Example on Linux: to compile it in `Release` mode and `ninja` generator
 ```
@@ -178,4 +180,4 @@ docker run -ti -e "TERM=xterm-256color" local-coincenter --help
 
 Tests are compiled only if `coincenter` is built as a main project by default. You can set `cmake` flag `CCT_ENABLE_TESTS` to 1 or 0 to change this behavior.
 
-Note that exchanges API are also unit tested. If no private key is found, only public exchanges will be tested, private exchanges will be skipped and unit test will not fail.
+Note that exchanges API are also unit tested. If no private key is found, only public exchanges will be tested, private exchanges will be skipped and unit test will not fail.