diff options
author | zvecr <git@zvecr.com> | 2019-02-15 04:14:26 +0000 |
---|---|---|
committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-02-14 20:14:26 -0800 |
commit | 40e67a3074293bc8e96574e7d603a943d3ca8d38 (patch) | |
tree | 1e152c2282a4a0737e1a5952ec4ac6d96a333b63 /docs/feature_layouts.md | |
parent | 85022f8bb5129f7118b55556c1ce85bc7d721356 (diff) | |
download | qmk_firmware-40e67a3074293bc8e96574e7d603a943d3ca8d38.tar.gz qmk_firmware-40e67a3074293bc8e96574e7d603a943d3ca8d38.zip |
Add a mechanism for force building a particular community layout (#5027)
* Add a mechanism for force building a particular community layout
* Add docs for FORCE_LAYOUT argument
* Update output name when FORCE_LAYOUT is enabled
Diffstat (limited to 'docs/feature_layouts.md')
-rw-r--r-- | docs/feature_layouts.md | 29 |
1 files changed, 29 insertions, 0 deletions
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`: | |||
51 | 51 | ||
52 | but the `LAYOUT_<layout>` variable must be defined in `<folder>.h` as well. | 52 | but the `LAYOUT_<layout>` variable must be defined in `<folder>.h` as well. |
53 | 53 | ||
54 | ## Building a Keymap | ||
55 | |||
56 | You should be able to build the keyboard keymap with a command in this format: | ||
57 | |||
58 | make <keyboard>:<layout> | ||
59 | |||
60 | ### Conflicting layouts | ||
61 | When a keyboard supports multiple layout options, | ||
62 | |||
63 | LAYOUTS = ortho_4x4 ortho_4x12 | ||
64 | |||
65 | And a layout exists for both options, | ||
66 | ``` | ||
67 | layouts/ | ||
68 | + community/ | ||
69 | | + ortho_4x4/ | ||
70 | | | + <layout>/ | ||
71 | | | | + ... | ||
72 | | + ortho_4x12/ | ||
73 | | | + <layout>/ | ||
74 | | | | + ... | ||
75 | | + ... | ||
76 | ``` | ||
77 | |||
78 | The FORCE_LAYOUT argument can be used to specify which layout to build | ||
79 | |||
80 | make <keyboard>:<layout> FORCE_LAYOUT=ortho_4x4 | ||
81 | make <keyboard>:<layout> FORCE_LAYOUT=ortho_4x12 | ||
82 | |||
54 | ## Tips for Making Layouts Keyboard-Agnostic | 83 | ## Tips for Making Layouts Keyboard-Agnostic |
55 | 84 | ||
56 | ### Includes | 85 | ### Includes |