diff options
| author | QMK Bot <hello@qmk.fm> | 2022-01-13 02:29:55 +0000 |
|---|---|---|
| committer | QMK Bot <hello@qmk.fm> | 2022-01-13 02:29:55 +0000 |
| commit | 69e4c181530bd8c6d9b5d91712dc97f7fdfbd43f (patch) | |
| tree | 809a66d0c30c2883d16f267e7480d7b0e42fd91f /docs | |
| parent | 2609c49731cd5fc63480ccacd85359de72b266ba (diff) | |
| parent | 362a65510a0fe80a6fa56400b4b8089accde21c7 (diff) | |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/newbs_building_firmware.md | 16 | ||||
| -rw-r--r-- | docs/newbs_getting_started.md | 16 |
2 files changed, 15 insertions, 17 deletions
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md index ed94a1460d..ed51a9aea5 100644 --- a/docs/newbs_building_firmware.md +++ b/docs/newbs_building_firmware.md @@ -2,6 +2,20 @@ Now that you have setup your build environment you are ready to start building custom firmware. For this section of the guide we will bounce between 3 programs- your file manager, your text editor, and your terminal window. Keep all 3 open until you are done and happy with your keyboard firmware. +## Configure Your Build Environment Defaults (Optional) + +You can configure your build environment to set the defaults and make working with QMK less tedious. Let's do that now! + +Most people new to QMK only have 1 keyboard. You can set this keyboard as your default with the `qmk config` command. For example, to set your default keyboard to `clueboard/66/rev4`: + + qmk config user.keyboard=clueboard/66/rev4 + +?> 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`. + +You can also set your default keymap name. Most people use their GitHub username like the keymap name from the previous steps: + + qmk config user.keymap=<github_username> + ## Create a New Keymap To create your own keymap you'll want to create a copy of the `default` keymap. If you configured your build environment in the last step you can do that easily with the QMK CLI: @@ -45,7 +59,7 @@ When your changes to the keymap are complete you will need to build the firmware qmk compile -If you did not configure your environment, or you have multiple keyboards, you can specify a keyboard and/or keymap: +If you did not configure defaults for your environment, or you have multiple keyboards, you can specify a keyboard and/or keymap: qmk compile -kb <keyboard> -km <keymap> diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 5dbaa56169..d6c080173c 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -182,22 +182,6 @@ Checking file size of clueboard_66_rev3_default.hex * The firmware size is fine - 26356/28672 (2316 bytes free) ``` -## 5. Configure Your Build Environment (Optional) - -You can configure your build environment to set the defaults and make working with QMK less tedious. Let's do that now! - -Most people new to QMK only have 1 keyboard. You can set this keyboard as your default with the `qmk config` command. For example, to set your default keyboard to `clueboard/66/rev4`: - - qmk config user.keyboard=clueboard/66/rev4 - -You can also set your default keymap name. Most people use their GitHub username here, and we recommend that you do too. - - qmk config user.keymap=<github_username> - -The keyboard can now be compiled without arguments using the following command after creating your keymap in the next section: - - qmk compile - # Creating Your Keymap You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware.md) for that. |