]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)
authorEvan Travers <evantravers@gmail.com>
Wed, 29 Aug 2018 00:35:24 +0000 (19:35 -0500)
committerDrashna Jaelre <drashna@live.com>
Wed, 29 Aug 2018 00:35:24 +0000 (17:35 -0700)
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.

docs/feature_layouts.md

index bfae9204401833efb2f12762b1c95ce3ed3a0cd7..1ee8b5e35c6ea1e4bbcf86341ad8efc7c6d89d40 100644 (file)
@@ -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.