summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Travers <evantravers@gmail.com>2018-08-28 19:35:24 -0500
committerDrashna Jaelre <drashna@live.com>2018-08-28 17:35:24 -0700
commit08c682c193f43e5d54df990680ae93fc2e06150a (patch)
tree0a6ca5e281f67820f2ab484e4605c796343490c8
parent9bd6d6112d698ea5823b268983809fe3b8d98b26 (diff)
downloadqmk_firmware-08c682c193f43e5d54df990680ae93fc2e06150a.tar.gz
qmk_firmware-08c682c193f43e5d54df990680ae93fc2e06150a.zip
Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)
When moving my planck layout to my let's split, I ran into this issue because I had copied my planck layout from the default layout which just used the `{}` array form for the keymap layers. I checked the docs, but this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on discord, but this seemed to be the logical place to add a helpful hint.
-rw-r--r--docs/feature_layouts.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/feature_layouts.md b/docs/feature_layouts.md
index bfae920440..1ee8b5e35c 100644
--- a/docs/feature_layouts.md
+++ b/docs/feature_layouts.md
@@ -53,6 +53,8 @@ but the `LAYOUT_<layout>` variable must be defined in `<folder>.h` as well.
## Tips for Making Layouts Keyboard-Agnostic
+### Includes
+
Instead of using `#include "planck.h"`, you can use this line to include whatever `<keyboard>.h` (`<folder>.h` should not be included here) file that is being compiled:
#include QMK_KEYBOARD_H
@@ -72,3 +74,7 @@ For example:
```
Note that the names are lowercase and match the folder/file names for the keyboard/revision exactly.
+
+### Keymaps
+
+In order to support both split and non-split keyboards with the same layout, you need to use the keyboard agnostic `LAYOUT_<layout name>` macro in your keymap. For instance, in order for a Let's Split and Planck to share the same layout file, you need to use `LAYOUT_ortho_4x12` instead of `LAYOUT_planck_grid` or just `{}` for a C array.