diff options
| author | skullY <skullydazed@gmail.com> | 2019-01-14 13:56:48 -0800 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2019-02-08 15:13:20 -0800 |
| commit | aeee735f3572d266a356926852838d4573369796 (patch) | |
| tree | 26e39834b85e006dbd532a7ead21e5119c79b9c1 | |
| parent | 330e2e6af532bc1531be78f3aedd3479b0573421 (diff) | |
| download | firmware-aeee735f3572d266a356926852838d4573369796.tar.gz firmware-aeee735f3572d266a356926852838d4573369796.tar.bz2 firmware-aeee735f3572d266a356926852838d4573369796.zip | |
Clarify LAYOUT vs LAYOUT_all
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 3a74e5f5c..c8aec40e0 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md @@ -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 | |