Updating README with some basic setup instructions

2026-09-06 00:43:34 -04:00
parent e6703ca6cb
commit c8bd72340c
1 changed files with 17 additions and 1 deletions
@@ -1,3 +1,19 @@
 # pico-thermo

 MicroPython app to read data from BME280 sensor and send it to Home Assistant
+
+## Running
+
+Flash your Raspberry Pi Pico with MicroPython.
+
+Copy `config.example.py` to `config.py` and edit the settings to match your environment.
+
+Copy `main.py` and `config.py` to the root of the filesystem on the Pico.
+
+Connect the BME280 sensor to your Pico and power on.
+
+Head on to your Home Assistant instance and enjoy!
+
+## License
+
+This project is made available under the BSD 3-Clause license.