From 7fd7a0cfe6ea435d6c48d656bb5e66a52d670d42 Mon Sep 17 00:00:00 2001
From: Alx-Lai <alexabc722@gmail.com>
Date: Sat, 13 Jul 2024 16:34:37 +0800
Subject: [PATCH] update README.md

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 11d16ee1..98a1592d 100644
--- 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
+```
\ No newline at end of file