Skip to content

Commit

Permalink
update dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marenz2569 committed Jan 15, 2025
1 parent b0da211 commit d7a9023
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions DeveloperDocumenation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ This document contains knowledge required to work on the FIRESTARTER project.

Code style follows the LLVM project.
It is enforced by an automatic CI check.
The current required version for `clang-format` and `clang-tidy` is `1.14` (the default for Ubuntu 22.04).

You should install them on your system. For Debian based linux distribution you can find the download [here](https://apt.llvm.org).
The currently used version for `clang-format` and `clang-tidy` is `1.14` (the default for Ubuntu 22.04).

When using VSCode as your editor it is recomended that you install the [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) and [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) extension.

Expand All @@ -23,5 +21,5 @@ Tests will be build when passing the variable `-DFIRESTARTER_BUILD_TESTS=ON` to

To run the standard set of tests run `ctest` in the build directory.

To run `clang-tidy` with your changes run `./tooling/clang-tidy.py clang-tidy-report --build-root <YOUR_BUILD_ROOT>`.
This will create a file called `clang-tidy-report.txt` with the failed clang-tidy checks in the build root.
To run `clang-tidy` with your changes execute `./tooling/clang-tidy.py clang-tidy-report --build-root <YOUR_BUILD_DIRECTORY>`.
This will create a file called `clang-tidy-report.txt` in the build root containing the failed clang-tidy checks.

0 comments on commit d7a9023

Please sign in to comment.