aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSam Anthony <sam@samanthony.xyz>2026-01-15 12:30:32 -0500
committerGitHub <noreply@github.com>2026-01-15 12:30:32 -0500
commitba028002692676fadf1e24f39cb1bb248bd0c049 (patch)
tree3fd617f4da8bec062d755f9e875a0289008a6b2c /README.md
parent65286a053d3546983a1b5b43cbb380540eb19cc3 (diff)
downloadcan-gauge-interface-ba028002692676fadf1e24f39cb1bb248bd0c049.zip
Create README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54ba246
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Analog Gauge Driver with CAN Interface
+
+Automotive electronic device that drives up to six analog gauges using data from a CAN bus.
+
+## Contents
+
+- [Hardware](hw) KiCad files for the PCB.
+- [Firmware](fw) that runs on the PIC microcontroller.
+- [Software](sw) for flashing calibration files onto the device.
+- [Documentation](doc) including the [report](doc/report/report.pdf).