Add instruction for a precommit hook to automatically clang-tidy the codebase before each commit.

Author: zyunlam

README.md

@@ -1,18 +1,18 @@
 # TARS Flight Software Repository
-Illinois Space Society's flight software codebase for the TARS system.
-
-<div align="center">
-<a href="https://www.youtube.com/watch?v=OQC60KljR3A"><img src="https://img.youtube.com/vi/OQC60KljR3A/0.jpg"></img></a><br>
-<i>Click to see a cool video!</i>
+Illinois Space Society's flight software codebase for the TARS system.
+
+<div align="center">
+<a href="https://www.youtube.com/watch?v=OQC60KljR3A"><img src="https://img.youtube.com/vi/OQC60KljR3A/0.jpg"></img></a><br>
+<i>Click to see a cool video!</i>
 </div>
 
 ### Directory Structure:
-- `TARS/`: Mission critical flight software running on TARS. This is the code that actually flies on the rocket
-	- `src/`: All the flight code that we write ourselves is in this directory. 
-		- `common/`: Utility code we write that is used across microcontrollers.
-		- `mcu_main/`: Code for the primary microcontroller on TARS (Teensy 4.1)
-		- `mcu_telemetry/`: Code for the microcontroller in charge of telemetry and GPS (ESP32-S3)
-		- `mcu_power`: Code for the microcontroller on the power board (ATMega328P)
+- `TARS/`: Mission critical flight software running on TARS. This is the code that actually flies on the rocket
+	- `src/`: All the flight code that we write ourselves is in this directory. 
+		- `common/`: Utility code we write that is used across microcontrollers.
+		- `mcu_main/`: Code for the primary microcontroller on TARS (Teensy 4.1)
+		- `mcu_telemetry/`: Code for the microcontroller in charge of telemetry and GPS (ESP32-S3)
+		- `mcu_power`: Code for the microcontroller on the power board (ATMega328P)
 	- `lib/`: Third-party libraries that are not available on the PlatformIO Registry. Other libraries are included via the `lib_deps` build flag in `platformio.ini`
 - `ground/`: Code running on ground station hardware (Adafruit LoRa Feather)
 
@@ -72,3 +72,5 @@ Things to keep in mind about code formatting:
   - Exempt directories should be listed in `.clang-format-ignore` so they don't get auto-formatted by the script.
   - Exempt directories should also be listed in `.github/workflows/clang_format_check.yml` on the lines with `exclude:`, so they're not checked for style violations by GitHub. 
 - Changing/tweaking the style guide is always option! If you have ideas, reach out!
+
+ - You can copy the file tools/precommit to .git/hooks with the command `cp tools/pre-commit .git/hooks/pre-commit` to automatically run clang tidy before committing.

tools/pre-commit

@@ -0,0 +1 @@
+python run_clang_format.py -r -i .