lukas/WordClockESP
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

more readme changes

Browse Source
This commit is contained in:
Rick Watson 2019-06-01 18:49:53 +01:00
parent 3d41e4f37d
commit e66deb9dc7
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,7 +2,7 @@
A simple, extensible framework for IoT projects built on ESP8266/ESP32 platforms with responsive React front-end. A simple, extensible framework for IoT projects built on ESP8266/ESP32 platforms with responsive React front-end.
Designed to work with the PlatformIO IDE with limited setup, please read below for build and flash instructions. Designed to work with the PlatformIO IDE with limited setup, please read below for build and upload instructions.
![Screenshots](/media/screenshots.png?raw=true "Screenshots") ![Screenshots](/media/screenshots.png?raw=true "Screenshots")
@ -38,10 +38,10 @@ The project directory structure is as follows:
Directory | Description Directory | Description
---- | ----------- ---- | -----------
/data/ | The file system image directory [data/](data) | The file system image directory
/interface/ | React based front end [interface/](interface) | React based front end
/src/ | C++ back end for the ESP8266 device [src/](src) | C++ back end for the ESP8266 device
/platformio.ini | PlatformIO project configuration file [platformio.ini](platformio.ini) | PlatformIO project configuration file
Once the platform and libraries are downloaded the back end should be compiling. Once the platform and libraries are downloaded the back end should be compiling.
@ -71,7 +71,7 @@ npm install
npm run build npm run build
``` ```
> **Note**: The build command will also delete the previously built interface (the ['data/www'](data/www) directory) and replace it with the freshly built one, ready for upload to the device. > **Note**: The build command will also delete the previously built interface, in the ['data/www'](data/www) directory, replacing it with the freshly built one ready to upload to the device.
#### Running the interface locally #### Running the interface locally