summaryrefslogtreecommitdiff
path: root/keyboards/mio/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mio/readme.md')
-rw-r--r--keyboards/mio/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/mio/readme.md b/keyboards/mio/readme.md
new file mode 100644
index 0000000000..6ae4fd049f
--- /dev/null
+++ b/keyboards/mio/readme.md
@@ -0,0 +1,23 @@
+# MIO
+
+![MIO](https://keys.recompile.net/images/mio-01@600w.jpg)
+
+High-end custom gaming keyboard.
+
+* Keyboard Maintainer: [Naoto Takai](https://github.com/takai)
+* Hardware Supported: Original MIO PCB
+* Hardware Availability: https://keys.recompile.net/projects/mio/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mio:default
+
+Flashing example for this keyboard:
+
+ make mio:default:flash
+
+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).
+
+## Bootloader Mode
+
+In order to flash the firmware, you need to put the keyboard into bootloader mode. To enable the bootloader mode, press the reset button (SW1) on the underside of the PCB.