summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJulius Degesys <Julius.Degesys@gmail.com>2023-04-03 01:42:14 -0400
committerGitHub <noreply@github.com>2023-04-03 15:42:14 +1000
commit12de0297edc601be867ea4e32b741967e88a2847 (patch)
treede30f6fd0060d3e2d8604c74b0fe7a6b6554a568 /docs
parent4992df56b8202e206f83ff529033864141e681ed (diff)
Suggest `qmk list-keyboards` when testing build environment (#19471)
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/newbs_getting_started.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 91bfa08310..b0d28d89d1 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -172,6 +172,8 @@ For example, to build a firmware for a Clueboard 66% you would use:
qmk compile -kb clueboard/66/rev3 -km default
+?> The keyboard option is the path relative to the keyboard directory, the above example would be found in `qmk_firmware/keyboards/clueboard/66/rev3`. If you're unsure you can view a full list of supported keyboards with `qmk list-keyboards`.
+
When it is done you should have a lot of output that ends similar to this:
```