fancypants md

This commit is contained in:
FrYakaTKoP
2017-10-30 00:20:20 +01:00
parent 3605540978
commit 9024ab3aa9

View File

@@ -1,7 +1,7 @@
# Esp8266-Laser
Wifi Host for the Arduino-Laser-Spirograph
# HTTP endpoints:
## HTTP endpoints:
* /spirograph
* **GET** returns laser and motor values (0 at startup)
* **POST** sets new value(s)
@@ -33,7 +33,7 @@ Wifi Host for the Arduino-Laser-Spirograph
* **GET** returns /presets.json
# Install
## Install
- install arduino ide (1.8.5) or PlatformIO (see Development section for further instructions)
- follow this instruction
@@ -53,8 +53,8 @@ You may also need to:
- get and install driver for nodemcu
https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
# Development
PlatformIO
## Development
### PlatformIO
----------
The project is intended to run on PlatformIO and the build environment is configured for NodeMCU 0.9 (ESP-12 Module).
More informations: http://docs.platformio.org/en/latest/platforms/espressif8266.html
@@ -90,16 +90,16 @@ build:firmware
upload:firmware
```
Frontend
### Frontend
--------
Frontend development requires NodeJS / npm.
The development server watches all files in the frontend directory and automatically builds and copies the frontend code to the data folder.
```
# run development server on port 8080
### run development server on port 8080
npm run dev
# build distribution source to data folder
### build distribution source to data folder
npm run build
```