Implement kb function for rgb matrix to led lookup (#5738)

[qmk_firmware.git] / keyboards / kmac / readme.md

diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md
index e7d97778f6805146983cc0a6ad872b6ab1faac62..cd181a5f68a348d01fe706e110885afd03579866 100644 (file)
--- 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.
 
@@ -21,7 +20,7 @@ For the full Quantum feature list, see the [documentation](https://docs.qmk.fm).
 
 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 [keyboards/kmac](/keyboards/kmac) folder.
+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
 
@@ -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 <keymap name>`