Add configuration files for code formatter tools

This commit is contained in:
L-diy
2023-10-24 18:17:15 +02:00
parent efff4ee8d1
commit 997a1db060
3 changed files with 282 additions and 2 deletions

View File

@@ -2,11 +2,29 @@
## Used Libs, compiler and apps
- lwip version 2.1.2
- CubeIDE version 1.12.1
- CubeIDE version 1.12.1
- Firmware Lib (stm32f7) 1.17.1
## Tasks
Maak per taak een apparte c en h file aan. De naam van de file is de naam van de taak.
Zo kunnen we de code proper houden.
[taken_en_verdeling.md](Taken_en_Verdeling.md)
[taken_en_verdeling.md](Taken_en_Verdeling.md)
## Style Guide
To maintain a consistent and clean codebase, follow the [style guide](style_guide.md). This document provides detailed instructions on naming conventions, code structure, and commenting practices.
Please read the [style_guide.md](style_guide.md) carefully before making contributions.
### Editor Configuration
To help you adhere to the style guide, use the provided configuration files for the code formatters in your code editor.
You can choose from the following options:
- `.clang-format`:
- For [Visual Studio Code](https://code.visualstudio.com/docs/cpp/cpp-ide#_code-formatting) and [CLion](https://www.jetbrains.com/help/clion/clangformat-as-alternative-formatter.html#clion-support) users
- Or use the [clang-format](https://clang.llvm.org/docs/ClangFormat.html) tool directly
- `eclipse_format.xml`:
- For Eclipse-based editors, including STM32CubeIDE.
- You can import it within eclipse settings, `Preferences -> LANGUAGE -> Code Style -> Formatter` tab.