aboutsummaryrefslogtreecommitdiff
path: root/docs/hardware_keyboard_guidelines.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hardware_keyboard_guidelines.md')
-rw-r--r--docs/hardware_keyboard_guidelines.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index d49d0d092..742b56572 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -3,6 +3,25 @@
3Since starting, QMK has grown by leaps and bounds thanks to people like you who contribute to creating and maintaining our community keyboards. As we've grown we've discovered some patterns that work well, and ask that you conform to them to make it easier for other people to benefit from your hard work. 3Since starting, QMK has grown by leaps and bounds thanks to people like you who contribute to creating and maintaining our community keyboards. As we've grown we've discovered some patterns that work well, and ask that you conform to them to make it easier for other people to benefit from your hard work.
4 4
5 5
6## Use QMK Lint
7
8We have provided a tool, `qmk lint`, which will let you check over your keyboard for problems. We suggest using it frequently while working on your keyboard and keymap.
9
10Example passing check:
11
12```
13$ qmk lint -kb rominronin/katana60/rev2
14Ψ Lint check passed!
15```
16
17Example failing check:
18
19```
20$ qmk lint -kb clueboard/66/rev3
21☒ Missing keyboards/clueboard/66/rev3/readme.md
22☒ Lint check failed!
23```
24
6## Naming Your Keyboard/Project 25## Naming Your Keyboard/Project
7 26
8All keyboard names are in lower case, consisting only of letters, numbers, and underscore (`_`). Names may not begin with an underscore. Forward slash (`/`) is used as a sub-folder separation character. 27All keyboard names are in lower case, consisting only of letters, numbers, and underscore (`_`). Names may not begin with an underscore. Forward slash (`/`) is used as a sub-folder separation character.