small README section for formatting

This commit is contained in:
Robin Müller 2021-12-01 16:17:27 +01:00
parent fd7581f8ba
commit 15dddd7fc4
No known key found for this signature in database
GPG Key ID: 11D4952C8CCEF814
1 changed files with 6 additions and 0 deletions

View File

@ -107,6 +107,12 @@ cmake --build . -- fsfw-tests_coverage -j
The `coverage.py` script located in the `script` folder can also be used to do this conveniently.
## Formatting the sources
The formatting is done by the `clang-format` tool. The configuration is contained within the
`.clang-format` file in the repository root. As long as `clang-format` is installed, you
can run the `apply-clang-format.sh` helper script to format all source files consistently.
## Index
[1. High-level overview](doc/README-highlevel.md#top) <br>