]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Clarify the format for layout names
authorskullY <skullydazed@gmail.com>
Fri, 19 Jan 2018 19:58:19 +0000 (11:58 -0800)
committerskullY <skullydazed@gmail.com>
Fri, 19 Jan 2018 19:58:19 +0000 (11:58 -0800)
docs/feature_layouts.md

index 24c42c09feb1867f0cd885adba47035c4217c843..bfae9204401833efb2f12762b1c95ce3ed3a0cd7 100644 (file)
@@ -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