From 93ffc1a55b0d60920a3f1adf715500589c02aa43 Mon Sep 17 00:00:00 2001
From: Dirk Jahnke <dirk.jahnke@mailbox.org>
Date: Wed, 24 Jan 2018 18:00:28 +0100
Subject: [PATCH] Added README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ef1d3a
--- /dev/null
+++ b/README.md
@@ -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
+