X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_layouts.md;h=24c42c09feb1867f0cd885adba47035c4217c843;hb=e956c11bc96814872b142a8f97e03e2935d285b6;hp=11f5831bbd14a239d2bc23cb45935a2d7b11ba72;hpb=c8bdc75e1d3123a4ccf8631d70dc187bfeb7bc09;p=qmk_firmware.git diff --git a/docs/feature_layouts.md b/docs/feature_layouts.md index 11f5831bb..24c42c09f 100644 --- a/docs/feature_layouts.md +++ b/docs/feature_layouts.md @@ -1,6 +1,6 @@ -# Layouts: Using a keymap with multiple keyboards +# Layouts: Using a Keymap with Multiple Keyboards -The `layouts/` folder contains different physical key layouts that can apply to different keyboards. +The `layouts/` folder contains different physical key layouts that can apply to different keyboards. ``` layouts/ @@ -21,7 +21,7 @@ layouts/ | + ... ``` -The `layouts/default/` and `layouts/community/` are two examples of layout "repositories" - currently `default` will contain all of the information concerning the layout, and one default keymap named `default_`, for users to use as a reference. `community` contains all of the community keymaps, with the eventual goal of being split-off into a separate repo for users to clone into `layouts/`. QMK searches through all folders in `layouts/`, so it's possible to have multiple reposistories here. +The `layouts/default/` and `layouts/community/` are two examples of layout "repositories" - currently `default` will contain all of the information concerning the layout, and one default keymap named `default_`, for users to use as a reference. `community` contains all of the community keymaps, with the eventual goal of being split-off into a separate repo for users to clone into `layouts/`. QMK searches through all folders in `layouts/`, so it's possible to have multiple repositories here. Each layout folder is named (`[a-z0-9_]`) after the physical aspects of the layout, in the most generic way possible, and contains a `readme.md` with the layout to be defined by the keyboard: @@ -33,9 +33,9 @@ Each layout folder is named (`[a-z0-9_]`) after the physical aspects of the layo New names should try to stick to the standards set by existing layouts, and can be discussed in the PR/Issue. -## Supporting a layout +## Supporting a Layout -For a keyboard to support a layout, the variable (`[a-z0-9_]`) must be defined in it's `.h`, and match the number of arguments/keys (and preferrably the physical layout): +For a keyboard to support a layout, the variable (`[a-z0-9_]`) must be defined in it's `.h`, and match the number of arguments/keys (and preferably the physical layout): #define LAYOUT_60_ansi KEYMAP_ANSI @@ -49,7 +49,7 @@ The folder name must be added to the keyboard's `rules.mk`: but the `LAYOUT_` variable must be defined in `.h` as well. -## Tips for making layouts keyboard-agnostic +## Tips for Making Layouts Keyboard-Agnostic Instead of using `#include "planck.h"`, you can use this line to include whatever `.h` (`.h` should not be included here) file that is being compiled: