Merge branch 'master' of https://github.com/qmk/qmk_firmware

1 files changed, 37 insertions, 0 deletions

diff --git a/keyboards/model01/readme.md b/keyboards/model01/readme.md
new file mode 100644
index 0000000000..34bd291e2e
--- /dev/null
+++ b/keyboards/model01/readme.md
@@ -0,0 +1,37 @@
+# Keyboardio Model 01
+
+A split keyboard.
+
+Keyboard Maintainer: QMK Community  
+Hardware Supported: Keyboardio Model 01  
+Hardware Availability: [Keyboardio](https://shop.keyboard.io)  
+
+Make example for this keyboard (after setting up your build environment):
+
+    make model01:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Programming the Keyboard
+
+To program the keyboard, if you have avrdude installed:
+
+    make model01:default:avrdude
+
+When prompted to reset your keyboard, press the prog key at upper left. If the
+keyboard does not reset, you can hold the prog key while plugging it into your
+computer. The prog key will light up red in programming mode.
+
+## Features
+
+This implements the standard keymap, including mousekeys.
+
+It doesn't do cursor warping - QMK does not support absolute mouse positioning.
+
+LED support is limited. Gamma compensation and the high speed batch update
+functions supported by the hardware are not implemented. The high current power
+switch is also not implemented, so if you try and turn all the LEDs on at full
+brightness, something may conk out.
+
+Hotplugging the two halves works but is not extensively tested.