Add Doxygen documentation

.github/workflows/publish_doxygen.yml

@@ -0,0 +1,25 @@
+---
+name: "Publish Doxygen Docs"
+
+on:
+ push:
+ branches:
+ - "master"
+
+jobs:
+ publish:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: Build Doxygen
+ uses: mattnotmitt/doxygen-action@v1.1.0
+ with:
+ doxyfile-path: 'Doxyfile'
+
+ - name: Publish Doxygen to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3.6.4
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./apidocs/html

.gitignore

@@ -28,3 +28,6 @@ CTestTestfile.cmake
 bin/esp8266_wifi.bin
 bin/esp8266_serial.bin
 bin/esp32_wifi_tft.bin
+
+apidocs/
+*.sw?

README.md

@@ -9,9 +9,9 @@ This project seeks to implement the BrewPi firmware onto an ESP8266 controller.
 * [Full Installation Instructions](docs/INSTALL.md) (including custom brewpi-script)
 * [Installing the Firmware](docs/Installing%20the%20Firmware.md)
 * [Developing/Contributing](docs/DEVELOP.md)
-* [PCB Information](hardware/README.md) - PCB files, ordering and BOMs
+* [Hardware Information](https://github.com/thorrak/thorrak_hardware/blob/master/BrewPi-ESP8266.md) - PCB files, ordering and BOMs
 
-## Expected Pinout *(NOTE - CHANGED IN v0.3!)*
+## Expected Pinout
 * D0 - Heat
 * D1 - I2C SCL
 * D2 - I2C SDA

docs/Installing the Firmware.md

@@ -1,6 +1,16 @@
 # Installing the Firmware
 
-## Linux/Raspberry Pi
+## BrewFlasher & Fermentrack
+
+The easiest way to install the firmware is using either [BrewFlasher](http://www.brewflasher.com/) or the firmware flow in [Fermentrack](http://www.fermentrack.com/). 
+
+BrewFlasher is a standalone application for MacOS and Windows that allows for the firmware to be automatically downloaded & flashed to your controller. It was specifically designed to make flashing *this* project easy. For most users, this is the ideal installation method.
+
+Fermentrack is a web interface that BrewPi controllers can connect to/be managed by. If you were already planning on using Fermentrack to manage your BrewPi controller then this is a perfect alternative to either using BrewFlasher or flashing manually. 
+
+## Manual Installation Methods
+
+### Linux/Raspberry Pi - Manual
 The easiest way is to use the custom script in my brewpi-tools fork, though the script only completes steps 1 & 4 of the below. Alternatively, you can install this manually by doing the following:
 
 1. Install esptool using PIP (`pip install esptool`)