1 files changed, 37 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..eaa54fd
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+Introduction
+============
+
+A firmware Sketch for the Keyboardio Model 01.  Based algerno's:
+https://git.madhouse-project.org/algernon/Model01-Sketch#base-layer
+
+
+Build
+=====
+
+Arduino 1.6.7 or newer is required.  Unfortunately, as of 2019-06-25 the
+version found in Debian sid is too old (cf. #780706, #925578, #927329).
+Dowload a recent version at https://www.arduino.cc and it unpack to
+/usr/local/arduino.
+
+Initialize (or update) submodules:
+
+    ~$ git submodule update --init \
+            lib/hardware/keyboardio
+
+    ~$ git -C lib/hardware/keyboardio submodule update --init --recursive \
+            "avr/bootloaders/*" \
+            "avr/libraries/Kaleidoscope" \
+            "avr/libraries/Kaleidoscope-HIDAdaptor-KeyboardioHID" \
+            "avr/libraries/Keyboardio*" \
+            "build-tools"
+
+    ~$ make
+
+
+Flash firmware
+==============
+
+    ~$ make flash
+
+Press down the 'prog' key while the board is rebooting.  You can release
+it once it glows red.