]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Clarify LAYOUT vs LAYOUT_all
authorskullY <skullydazed@gmail.com>
Mon, 14 Jan 2019 21:56:48 +0000 (13:56 -0800)
committerskullydazed <skullydazed@users.noreply.github.com>
Fri, 8 Feb 2019 23:13:20 +0000 (15:13 -0800)
docs/hardware_keyboard_guidelines.md

index 3a74e5f5c8899b27a1db7e7133df7b82f40e4d79..c8aec40e072fb418fb60c54c68c4f95d38d2bdd1 100644 (file)
@@ -78,9 +78,11 @@ The following functions are typically defined in this file:
 
 ### `<keyboard_name.h>`
 
-This file is used to define the matrix for your keyboard. You should define at least one C macro named `LAYOUT` which translates an array into a matrix representing the physical switch matrix for your keyboard. If it's possible to build your keyboard with multiple layouts you may define additional macros.
+This file is used to define the matrix for your keyboard. You should define at least one C macro which translates an array into a matrix representing the physical switch matrix for your keyboard. If it's possible to build your keyboard with multiple layouts you should define additional macros.
 
-When defining multiple layouts you should have a base layout, named `LAYOUT`, that supports all possible switch positions on your matrix, even if that layout is impossible to build physically. This is the macro you should use in your `default` keymap. You should then have additional keymaps named `default_<layout>` that use your other layout macros. This will make it easier for people to use the layouts you define.
+If you have only a single layout you should call this macro `LAYOUT`.
+
+When defining multiple layouts you should have a base layout, named `LAYOUT_all`, that supports all possible switch positions on your matrix, even if that layout is impossible to build physically. This is the macro you should use in your `default` keymap. You should then have additional keymaps named `default_<layout>` that use your other layout macros. This will make it easier for people to use the layouts you define.
 
 Layout macro names are entirely lowercase, except for the word `LAYOUT` at the front.
 
@@ -88,7 +90,7 @@ As an example, if you have a 60% PCB that supports ANSI and ISO you might define
 
 | Layout Name | Keymap Name | Description |
 |-------------|-------------|-------------|
-| LAYOUT | default | A layout that supports both ISO and ANSI |
+| LAYOUT_all | default | A layout that supports both ISO and ANSI |
 | LAYOUT_ansi | default_ansi | An ANSI layout |
 | LAYOUT_iso | default_iso | An ISO layout |