From 703f6f06e9b1ea7f5d76a418f438bc79b9df3903 Mon Sep 17 00:00:00 2001 From: Julius Degesys Date: Sun, 1 Jan 2023 16:48:26 -0500 Subject: [PATCH 1/3] Update newbs_getting_started.md Add `qmk list-keyboards` to the getting started guide. --- docs/newbs_getting_started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 99aee121397a..11d7f279e427 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -166,6 +166,8 @@ For example, to build a firmware for a Clueboard 66% you would use: qmk compile -kb clueboard/66/rev3 -km default +You can use `qmk list-keyboards` to see a list of valid keyboards. + When it is done you should have a lot of output that ends similar to this: ``` From e2be13e7406fe421aa58f7ede85d9f79a4edadfd Mon Sep 17 00:00:00 2001 From: Julius Degesys Date: Mon, 2 Jan 2023 07:46:37 -0500 Subject: [PATCH 2/3] Mirror language in docs/newbs_building_firmware.md Co-authored-by: Joel Challis --- docs/newbs_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 11d7f279e427..2dbe7eb6a19f 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -166,7 +166,7 @@ For example, to build a firmware for a Clueboard 66% you would use: qmk compile -kb clueboard/66/rev3 -km default -You can use `qmk list-keyboards` to see a list of valid keyboards. +?> The keyboard option is the path relative to the keyboard directory, the above example would be found in `qmk_firmware/keyboards/clueboard/66/rev4`. 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: From 1dcb06494d1c06bab3f7078d3abeb570d0a38c73 Mon Sep 17 00:00:00 2001 From: Julius Degesys Date: Wed, 4 Jan 2023 09:27:08 -0500 Subject: [PATCH 3/3] Actually match example in documentation rev4 -> rev3 Co-authored-by: Joel Challis --- docs/newbs_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 2dbe7eb6a19f..0923c52cfb88 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -166,7 +166,7 @@ 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/rev4`. If you're unsure you can view a full list of supported keyboards with `qmk list-keyboards`. +?> 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: