Skip to content

Commit

Permalink
Start writing dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marenz2569 committed Jan 15, 2025
1 parent e033026 commit b0da211
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions DeveloperDocumenation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Developer Documentation

This document contains knowledge required to work on the FIRESTARTER project.

## Coding Guidelines

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).

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.

## Building

The project can be build using CMake.
See `Building FIRESTARTER` Section in the Readme for more details.

## Running tests

Tests will be build when passing the variable `-DFIRESTARTER_BUILD_TESTS=ON` to CMake.

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.

0 comments on commit b0da211

Please sign in to comment.