Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggest qmk list-keyboards when testing build environment #19471

Merged
merged 3 commits into from
Apr 3, 2023
Merged

Suggest qmk list-keyboards when testing build environment #19471

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
703f6f0
Update newbs_getting_started.md
JuliusDegesys Jan 1, 2023
e2be13e
Mirror language in docs/newbs_building_firmware.md
JuliusDegesys Jan 2, 2023
1dcb064
Actually match example in documentation
JuliusDegesys Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/newbs_getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

?> 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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth mentioning that it supports autocomplete/tab completion, too. eg `qmk -kb moon(tab) will show "moon" and "moonlander" as options. May not work on every system, though.


When it is done you should have a lot of output that ends similar to this:

```
Expand Down