aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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).