Michel2/RTClib
1
0
Fork 0
mirror of https://github.com/adafruit/RTClib.git synced 2026-07-28 04:05:31 +00:00
Code Issues Releases Activity

Document the code formatting requirements

Browse Source 
Update README.md to inform contributors about the code formatting
requirements enforced by the CI pipeline through clang-format.
This commit is contained in:
Edgar Bonet
2020-08-03 12:49:35 +02:00
parent aa8f142deb
commit 9c4c5fce98
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7
View File
@@ -61,6 +61,13 @@ https://learn.adafruit.com/the-well-automated-arduino-library/doxygen
https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips
## Code formatting and clang-format
The code should be formatted according to the [LLVM Coding Standards][std], which is the default of the clang-format tool. The easiest way to ensure conformance is to [install clang-format][llvm] and run
```shell
clang-format -i <source_file>`
```
Written by JeeLabs
MIT license, check license.txt for more information
All text above must be included in any redistribution