Added README

This commit is contained in:
Dirk Jahnke 2018-01-24 18:00:28 +01:00
parent 1d74a399b5
commit 93ffc1a55b
1 changed files with 22 additions and 0 deletions

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Fastclock Client
## Model Railroad Fastclock Client
### Hardware Prerequisites
- ESP8266 or ESP32, e.g. Wemos Mini D1
- OLED Display 64x48 (Wemos shield)
- Battery (LiIon) support
### Software Prerequisites
- Uses the ssd1306dj library, which is derived from Adafruit to support 64x48 resolution
- Fastclock Server (WLAN/Network based)
- Mongoose installed (being able to start "mos" on the command line)
### Howto flash
Standard procedure, as with any other App.
- git clone this repo
- git clone the ssd1306dj library, use following file structure
- .../libs/ssd1306dj/...
- .../fastclockClient/...
- .../fastclockServer/...
- build locally: mos build --local && mos flash