diff options
| author | Konstantin Đorđević <vomindoraan@gmail.com> | 2019-01-14 19:00:03 +0100 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2019-02-09 00:13:20 +0100 |
| commit | 24b7d058e2e456dc4ec9cd1e640374b033b57223 (patch) | |
| tree | d4904df1eaca45b578b3a7c638d1f6f3c7de6d71 /docs | |
| parent | a45b625b6253c30a573f29684829b6200c12b8a3 (diff) | |
| download | qmk_firmware-24b7d058e2e456dc4ec9cd1e640374b033b57223.tar.gz qmk_firmware-24b7d058e2e456dc4ec9cd1e640374b033b57223.tar.xz | |
Update docs/hardware_keyboard_guidelines.md
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 6b996ecf6..e6be7aece 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md @@ -72,7 +72,7 @@ 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 CPP macro named `LAYOUT` which translates an array into a matrix representing your switch matrix. 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 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. 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. |