summaryrefslogtreecommitdiff
path: root/keyboards/kbdmania/kmac/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kbdmania/kmac/readme.md')
-rw-r--r--keyboards/kbdmania/kmac/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kbdmania/kmac/readme.md b/keyboards/kbdmania/kmac/readme.md
new file mode 100644
index 0000000000..c9f7746292
--- /dev/null
+++ b/keyboards/kbdmania/kmac/readme.md
@@ -0,0 +1,21 @@
+# KMAC
+
+A Korean custom keyboard designed by Byungho Kim and the KBDMania community.
+
+Keyboard Maintainer: [Mathias Andersson](https://github.com/wraul)
+Hardware Supported: KMAC & KMAC 2
+Hardware Availability: [KBDMania](http://www.kbdmania.net/xe/news/5232321)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbdmania/kmac: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).
+
+## Bootloader
+
+The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard.
+
+## PCB versions
+
+The KMAC are available with two different PCB layouts, a winkey version and a winkeyless version. A default keymap are provided for each versions of the PCB.