diff options
| author |  skullY <skullydazed@gmail.com> | 2018-01-19 11:58:19 -0800 |
|---|---|---|
| committer | skullY <skullydazed@gmail.com> | 2018-01-19 11:58:19 -0800 |
| commit | 2018df1a61136f5db5032fc7f0ecb6dff05c6351 (patch) | |
| tree | 91b3362911c2fd73a39e3adf63cc6974fa3a6558 | |
| parent | 365b86357825ebed7012377a5684269760326fd2 (diff) | |
| download | qmk_firmware-2018df1a61136f5db5032fc7f0ecb6dff05c6351.tar.gz | |
Clarify the format for layout names
| -rw-r--r-- | docs/feature_layouts.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_layouts.md b/docs/feature_layouts.md index 24c42c09f..bfae92044 100644 --- a/docs/feature_layouts.md +++ b/docs/feature_layouts.md @@ -35,10 +35,12 @@ New names should try to stick to the standards set by existing layouts, and can ## Supporting a Layout -For a keyboard to support a layout, the variable (`[a-z0-9_]`) must be defined in it's `<keyboard>.h`, and match the number of arguments/keys (and preferably the physical layout): +For a keyboard to support a layout, the variable must be defined in it's `<keyboard>.h`, and match the number of arguments/keys (and preferably the physical layout): #define LAYOUT_60_ansi KEYMAP_ANSI +The name of the layout must match this regex: `[a-z0-9_]+` + The folder name must be added to the keyboard's `rules.mk`: LAYOUTS = 60_ansi |