From b36b4382d0a1da12492c14a8b7f25ca036e0af6d Mon Sep 17 00:00:00 2001 From: Graham P Heath Date: Sat, 3 Mar 2018 11:52:09 -0600 Subject: [PATCH] Mention invalid names in the readme. (#2458) --- docs/hardware_keyboard_guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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`