aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md19
-rw-r--r--docs/hardware_keyboard_guidelines.md19
2 files changed, 37 insertions, 1 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index c970b1efa..b10f5d499 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -178,6 +178,24 @@ Creates a keymap.json from a keymap.c.
178qmk c2json [--no-cpp] [-o OUTPUT] filename 178qmk c2json [--no-cpp] [-o OUTPUT] filename
179``` 179```
180 180
181## `qmk lint`
182
183Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns.
184
185**Usage**:
186
187```
188qmk lint [-km KEYMAP] [-kb KEYBOARD] [--strict]
189```
190
191This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
192
193**Examples**:
194
195Do a basic lint check:
196
197 qmk lint -kb rominronin/katana60/rev2
198
181## `qmk list-keyboards` 199## `qmk list-keyboards`
182 200
183This command lists all the keyboards currently defined in `qmk_firmware` 201This command lists all the keyboards currently defined in `qmk_firmware`
@@ -309,4 +327,3 @@ This command runs the python test suite. If you make changes to python code you
309``` 327```
310qmk pytest 328qmk pytest
311``` 329```
312
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.