Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mjkl-gh authored Aug 18, 2022
1 parent 245b858 commit 06e5c6d
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You will need the following before you can get started.

### Flashing the device

Download the right Firmware from the release page. USB is for flashing over usb OTA is for updating an existing device which we will explain [here]()
Download the right Firmware from the release page. USB is for flashing over usb OTA is for updating an existing device which we will explain [here](#updating-a-device)

Attach the M5stickc or ESP32 to your computer using an usb cable. The device will pop up as available from the dropdown of serial port

Expand Down Expand Up @@ -76,12 +76,6 @@ For updating an existing device with new firmware first download the right firmw
Your device should be updated and reboot after a while. This might take a while depending on your esp-dsmr's network connection


### Building & uploading the interface

The interface has been configured with create-react-app and react-app-rewired so the build can customized for the target device. The large artefacts are gzipped and source maps and service worker are excluded from the production build. This reduces the production build to around ~150k, which easily fits on the device.

The interface will be automatically built by PlatformIO before it builds the firmware. The project can be configured to serve the interface from either PROGMEM or the filesystem as your project requires. The default configuration is to serve the content from PROGMEM, serving from the filesystem requires an additional upload step which is [documented below](#serving-the-interface-from-the-filesystem).

## Factory settings

The framework has built-in factory settings which act as default values for the various configurable services where settings are not saved on the file system.
Expand Down

0 comments on commit 06e5c6d

Please sign in to comment.