summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGraham P Heath <graham.p.heath@gmail.com>2018-03-03 11:52:09 -0600
committerskullydazed <skullydazed@users.noreply.github.com>2018-03-03 09:52:09 -0800
commitb36b4382d0a1da12492c14a8b7f25ca036e0af6d (patch)
tree67ebc675f56d1c33b7cb09c8346f856195074e91 /docs
parente87c39d3024908d646e2e0d80d0b63e68ac52f87 (diff)
Mention invalid names in the readme. (#2458)
Diffstat (limited to 'docs')
-rw-r--r--docs/hardware_keyboard_guidelines.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index 656f4c08cb..0892f85cb6 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -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`