aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBlaise Thompson <blaise@untzag.com>2021-03-09 13:54:56 -0600
committerBlaise Thompson <blaise@untzag.com>2021-03-09 13:54:56 -0600
commit024cd56cc903a255779e3a189d08f6e45c6d1097 (patch)
tree4c2b6b60431e574298ae6596b9166b4185ebff85
parent3a8495be5ad35f75f8dc84cf0c73797420f21427 (diff)
readme formatting
-rw-r--r--firmware/README.md9
1 files changed, 3 insertions, 6 deletions
diff --git a/firmware/README.md b/firmware/README.md
index 2159734..1cea550 100644
--- a/firmware/README.md
+++ b/firmware/README.md
@@ -1,12 +1,9 @@
# mqtt-weather-station firmware
-This project uses [micropython](https://micropython.org/), specifically [microhomie](https://github.com/microhomie/microhomie).
-Currently we build on microhomie-esp8266-v3.0.2, the binary is in the folder.
+This project uses [micropython](https://micropython.org/), specifically [microhomie](https://github.com/microhomie/microhomie). Currently we build on microhomie-esp8266-v3.0.2, the binary is in the folder.
-You must define the private information defined in `settings.py`.
-Copy `settings.py.example` to make a folder `settings.py` and define all relevant variables.
+You must define the private information defined in `settings.py`. Copy `settings.py.example` to make a folder `settings.py` and define all relevant variables.
-Run `flash.sh` to flash the board.
-You will need [esptool](https://github.com/espressif/esptool) and [ampy](https://github.com/scientifichackers/ampy).
+Run `flash.sh` to flash the board. You will need [esptool](https://github.com/espressif/esptool) and [ampy](https://github.com/scientifichackers/ampy).
We recommend an [FTDI Basic Breakout](https://www.sparkfun.com/products/9716) to physically program the ESP8266.