diff options
Diffstat (limited to 'keyboards/kmac/readme.md')
| -rw-r--r-- | keyboards/kmac/readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md new file mode 100644 index 000000000..e7d97778f --- /dev/null +++ b/keyboards/kmac/readme.md | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | KMAC keyboard firmware | ||
| 2 | ====================== | ||
| 3 | |||
| 4 | A Korean custom keyboard designed by Byungho Kim and the KBDMania community. | ||
| 5 | |||
| 6 | ## Supported models | ||
| 7 | |||
| 8 | All the tenkeyless models should be supported. | ||
| 9 | |||
| 10 | ## Bootloader | ||
| 11 | |||
| 12 | The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard. | ||
| 13 | |||
| 14 | It is also possible to use Boot Magic and Command to access the bootloader. | ||
| 15 | |||
| 16 | ## Quantum MK Firmware | ||
| 17 | |||
| 18 | For the full Quantum feature list, see the [documentation](https://docs.qmk.fm). | ||
| 19 | |||
| 20 | ## Building | ||
| 21 | |||
| 22 | 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. | ||
| 23 | |||
| 24 | 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 [keyboards/kmac](/keyboards/kmac) folder. | ||
| 25 | |||
| 26 | ### Winkey keymap | ||
| 27 | |||
| 28 | The [default keymap](keymaps/default) are designed for the winkey version of the PCB. | ||
| 29 | |||
| 30 | ### Winkeyless Keymap | ||
| 31 | |||
| 32 | A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also provided. | ||
| 33 | |||
| 34 | ### Custom keymaps | ||
| 35 | |||
| 36 | 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/Keymap.html) for details on how to modify the keymap. | ||
| 37 | |||
| 38 | To make it easy to define keymaps for the different versions of the PCB two macros are provided. | ||
| 39 | |||
| 40 | | PCB | Macro | | ||
| 41 | | -------------- | --------------------- | | ||
| 42 | | Winkey PCB | `KEYMAP()` | | ||
| 43 | | Winkeyless PCB | `KEYMAP_WINKEYLESS()` | | ||
| 44 | |||
| 45 | To build the firmware with a custom keymap, run `make <keymap name>` | ||
