diff options
author | QMK Bot <hello@qmk.fm> | 2024-05-30 09:00:58 +0000 |
---|---|---|
committer | QMK Bot <hello@qmk.fm> | 2024-05-30 09:00:58 +0000 |
commit | 6ca94ae1587d4dcbecb47c8ea93f134c0628eef9 (patch) | |
tree | 4cb5d945b8b75c7a8e639ade0fe6b3ae4bba1ff7 /docs/newbs_getting_started.md | |
parent | 47356b220101b4f5b8ca71b2e1aa4f04256dd60f (diff) | |
parent | b39285807e1d21300e8a5dbbf6f2c43a8aab3494 (diff) |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r-- | docs/newbs_getting_started.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 3a901ad7ad..9ebcccc77f 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -196,11 +196,15 @@ If you already know how to use GitHub, [we recommend that you follow these instr Now that your QMK build environment is set up, you can build a firmware for your keyboard. Start by trying to build the keyboard's default keymap. You should be able to do that with a command in this format: - qmk compile -kb <keyboard> -km default +```sh +qmk compile -kb <keyboard> -km default +``` For example, to build a firmware for a Clueboard 66% you would use: - qmk compile -kb clueboard/66/rev3 -km default +```sh +qmk compile -kb clueboard/66/rev3 -km default +``` ::: tip 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`. |