commit 24b7d058e2e456dc4ec9cd1e640374b033b57223 parent a45b625b6253c30a573f29684829b6200c12b8a3 Author: Konstantin Đorđević <firstname.lastname@example.org> Date: Mon, 14 Jan 2019 10:00:03 -0800 Update docs/hardware_keyboard_guidelines.md Co-Authored-By: skullydazed <email@example.com> Diffstat:
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git 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.