Merge remote-tracking branch 'origin/master' into develop
This commit is contained in:
commit
69e4c18153
2 changed files with 15 additions and 17 deletions
|
@ -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>
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue