update README.md

john0312 · Jul 13, 2024 · 7fd7a0c · 7fd7a0c
1 parent bc7fde2
commit 7fd7a0c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -67,3 +67,12 @@ execute `fw/merge.py` to merge STM32CubeIDE generated `main.c` with user code in
   * Bit time = 4/9.5kHz = 421us (each bit is 16 pulse).
   * LED refreshes at 9.5kHz/16 = 593Hz.
 
+## Format
+
+To check format, please install `clang-format` first.
+
+```sh
+# under hitcon-pcb-badge
+./lint.sh # check format
+./lint.sh -i # auto format
+```