X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fkmac%2Freadme.md;h=ec36c0a5c9bfeccfd85d96ef928d5b8c16b92f86;hb=ea7bb624de0b397c3055b9b879e0d5a9c0a237d6;hp=e7d97778f6805146983cc0a6ad872b6ab1faac62;hpb=517f75d893253e448105401ac638257841ad9e97;p=qmk_firmware.git diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md index e7d97778f..ec36c0a5c 100644 --- a/keyboards/kmac/readme.md +++ b/keyboards/kmac/readme.md @@ -1,5 +1,4 @@ -KMAC keyboard firmware -====================== +# KMAC keyboard firmware A Korean custom keyboard designed by Byungho Kim and the KBDMania community. @@ -33,13 +32,13 @@ A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also pr ### 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/Keymap.html) for details on how to modify the keymap. +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 | `KEYMAP()` | -| Winkeyless PCB | `KEYMAP_WINKEYLESS()` | +| PCB | Macro | +| -------------- | -------------- | +| Winkey PCB | `LAYOUT()` | +| Winkeyless PCB | `LAYOUT_WKL()` | To build the firmware with a custom keymap, run `make `