summaryrefslogtreecommitdiffstats
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2023-04-03 20:59:24 +1000
committerfauxpark <fauxpark@gmail.com>2023-04-03 20:59:24 +1000
commitbd4899f0ca1f687ac2ede437ffb5ad1af04f1abe (patch)
tree01d9f6709af24f5833dcdc3f3de5671d0766ccd8 /docs/newbs_getting_started.md
parentfcf8b804ed95a98561bd4c1d6c85604be0f7cc7b (diff)
parentd06ce0153bd4b608a20698c4a9e1d559b4c05683 (diff)
Merge remote-tracking branch 'upstream/master' into develop
Diffstat (limited to 'docs/newbs_getting_started.md')
-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:
```