initial commit

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..35aabc3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# MQTT weather station
+
+Simple station for monitoring environmental conditions in the lab over MQTT.
+
+Designed to work with [mqtt.chem.wisc.edu](https://mqtt.chem.wisc.edu/).
+
+## PCB
+
+This PCB was designed using KiCAD version 5.
+Refer to `weather.pdf` for schematic.
+PCB images generated with [tracespace](https://github.com/tracespace/tracespace) follow.
+
+![top](./top.png "PCB top view")
+
+![bottom](./bottom.png "PCB bottom view")
+
+Bill of Materials
+
+| reference      | value          | manufacturer | part number          | vendors |
+| :------------- | :------------- | :----------- | :------------------- | :------ |
+
+## Firmware
+
+TODO
+
+## Changelog
+
+### Unprinted
+
+### A
+
+#### Added
+- initial design