diff --git a/README.md b/README.md index 6c781bbf..9d166a62 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ Various tools, examples, and documentation for communicating with Hoymiles micro In particular: -* `doc/hoymiles-format-description.txt` is a detailed description of the communications format and the history of this project -* `doc/getting-started-ESP8266.md` shows the hardware setup for an ESP8266-based system +* `doc/hoymiles-format-description.txt` is a [detailed description of the communications format](doc/hoymiles-format-description.md) and the history of this project +* `doc/getting-started-ESP8266.md` shows the [hardware setup for an ESP8266-based system](doc/getting-started-ESP8266.md) * The `tools` folder contains various software tools for RaspberryPi, Arduino and ESP8266/ESP32: - * A [version for ESP8266](tools/esp8266) that includes a web interface - * A [version for Arduino Nano](tools/nano/NRF24_SendRcv) - * An [alternative Version of the above](tools/NRF24_SendRcv) - * A [different implementation](tools/HoyDtuSim) - * An [implementation for Raspberry Pi](tools/rpi) that polls an inverter and archives results as log files/stdout as well as posting them to an MQTT broker. + * A [version for ESP8266](tools/esp8266/) that includes an web interface + * A [version for Arduino Nano](tools/nano/NRF24_SendRcv/) + * An [alternative Version of the above](tools/NRF24_SendRcv/) + * A [different implementation](tools/HoyDtuSim/) + * An [implementation for Raspberry Pi](tools/rpi/) that polls an inverter and archives results as log files/stdout as well as posting them to an MQTT broker. Contributors are always welcome!