aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_layouts.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2017-12-09 16:36:32 +1100
committerJack Humbert <jack.humb@gmail.com>2017-12-09 10:46:11 -0500
commit7b0356d1d49da6574570e110f61f95692afdb3d0 (patch)
treea3e70802085ea8089f1e7851529f0296247fa264 /docs/feature_layouts.md
parent6eb89ae906db7f226570e1839b88dcdd3a8fa962 (diff)
downloadqmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.tar.gz
qmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.zip
Convert all headings to Title Case
Diffstat (limited to 'docs/feature_layouts.md')
-rw-r--r--docs/feature_layouts.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/feature_layouts.md b/docs/feature_layouts.md
index 11f5831bb..7bc55c6af 100644
--- a/docs/feature_layouts.md
+++ b/docs/feature_layouts.md
@@ -1,4 +1,4 @@
1# Layouts: Using a keymap with multiple keyboards 1# Layouts: Using a Keymap with Multiple Keyboards
2 2
3The `layouts/` folder contains different physical key layouts that can apply to different keyboards. 3The `layouts/` folder contains different physical key layouts that can apply to different keyboards.
4 4
@@ -33,7 +33,7 @@ Each layout folder is named (`[a-z0-9_]`) after the physical aspects of the layo
33 33
34New names should try to stick to the standards set by existing layouts, and can be discussed in the PR/Issue. 34New names should try to stick to the standards set by existing layouts, and can be discussed in the PR/Issue.
35 35
36## Supporting a layout 36## Supporting a Layout
37 37
38For a keyboard to support a layout, the variable (`[a-z0-9_]`) must be defined in it's `<keyboard>.h`, and match the number of arguments/keys (and preferrably the physical layout): 38For a keyboard to support a layout, the variable (`[a-z0-9_]`) must be defined in it's `<keyboard>.h`, and match the number of arguments/keys (and preferrably the physical layout):
39 39
@@ -49,7 +49,7 @@ The folder name must be added to the keyboard's `rules.mk`:
49 49
50but the `LAYOUT_<layout>` variable must be defined in `<folder>.h` as well. 50but the `LAYOUT_<layout>` variable must be defined in `<folder>.h` as well.
51 51
52## Tips for making layouts keyboard-agnostic 52## Tips for Making Layouts Keyboard-Agnostic
53 53
54Instead 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: 54Instead 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:
55 55