diff options
author | Drashna Jaelre <drashna@live.com> | 2019-04-09 08:58:11 -0700 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2019-04-09 08:58:11 -0700 |
commit | b6850bc043b1d129042f47501f0a1dc1e196f962 (patch) | |
tree | a0a772f278c3c494db3bc69103955af5561e1cae /keyboards/kmac/readme.md | |
parent | 19ed62114a1f5d20aacb9cbe83105e977b9a2971 (diff) |
remove all keyboards but ergodox and planck
Diffstat (limited to 'keyboards/kmac/readme.md')
-rw-r--r-- | keyboards/kmac/readme.md | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md deleted file mode 100644 index cd181a5f68..0000000000 --- a/keyboards/kmac/readme.md +++ /dev/null @@ -1,44 +0,0 @@ -# KMAC keyboard firmware - -A Korean custom keyboard designed by Byungho Kim and the KBDMania community. - -## Supported models - -All the tenkeyless models should be supported. - -## Bootloader - -The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard. - -It is also possible to use Boot Magic and Command to access the bootloader. - -## Quantum MK Firmware - -For the full Quantum feature list, see the [documentation](https://docs.qmk.fm). - -## Building - -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. - -Depending on which PCB and keymap you would like to use, you will have to compile the firmware slightly differently. All of the commands should be run in the [qmk root](https://github.com/qmk/qmk_firmware/) folder. - -### Winkey keymap - -The [default keymap](keymaps/default) are designed for the winkey version of the PCB. - -### Winkeyless Keymap - -A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also provided. - -### Custom keymaps - -To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/faq_keymap.html) for details on how to modify the keymap. - -To make it easy to define keymaps for the different versions of the PCB two macros are provided. - -| PCB | Macro | -| -------------- | -------------- | -| Winkey PCB | `LAYOUT()` | -| Winkeyless PCB | `LAYOUT_WKL()` | - -To build the firmware with a custom keymap, run `make <keymap name>` |