]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Mention invalid names in the readme. (#2458)
authorGraham P Heath <graham.p.heath@gmail.com>
Sat, 3 Mar 2018 17:52:09 +0000 (11:52 -0600)
committerskullydazed <skullydazed@users.noreply.github.com>
Sat, 3 Mar 2018 17:52:09 +0000 (09:52 -0800)
docs/hardware_keyboard_guidelines.md

index 656f4c08cb536480ce64c8a814a5f7d802ebf864..0892f85cb640b330a2ee75585f63c533cb5f07e2 100644 (file)
@@ -4,7 +4,7 @@ We welcome all keyboard projects into QMK, but ask that you try to stick to a co
 
 ## Naming Your Keyboard/Project
 
-All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format.
+All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format. `test`, `keyboard`, and `all` are reserved by make and are not a valid name for a keyboard.
 
 ## `readme.md`