X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_layouts.md;h=b34fd442d5c2f92d0ac460355591ecf894dab84e;hb=d686c0ea43d6a9db7768da64ee54c3ba25c018f7;hp=1ee8b5e35c6ea1e4bbcf86341ad8efc7c6d89d40;hpb=2bb2977c133646c4e056960e72029270d77cc1eb;p=qmk_firmware.git diff --git a/docs/feature_layouts.md b/docs/feature_layouts.md index 1ee8b5e35..b34fd442d 100644 --- a/docs/feature_layouts.md +++ b/docs/feature_layouts.md @@ -51,6 +51,35 @@ The folder name must be added to the keyboard's `rules.mk`: but the `LAYOUT_` variable must be defined in `.h` as well. +## Building a Keymap + +You should be able to build the keyboard keymap with a command in this format: + + make : + +### Conflicting layouts +When a keyboard supports multiple layout options, + + LAYOUTS = ortho_4x4 ortho_4x12 + +And a layout exists for both options, +``` +layouts/ ++ community/ +| + ortho_4x4/ +| | + / +| | | + ... +| + ortho_4x12/ +| | + / +| | | + ... +| + ... +``` + +The FORCE_LAYOUT argument can be used to specify which layout to build + + make : FORCE_LAYOUT=ortho_4x4 + make : FORCE_LAYOUT=ortho_4x12 + ## Tips for Making Layouts Keyboard-Agnostic ### Includes