aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2022-01-13 10:29:13 +0800
committerGitHub <noreply@github.com>2022-01-13 02:29:13 +0000
commit362a65510a0fe80a6fa56400b4b8089accde21c7 (patch)
treee81b251b6d37ae89c32d9f9badd425f1b8a27d45
parent06b329cdb98fc3a57d41e5815ab0d1c7d9f74299 (diff)
downloadqmk_firmware-362a65510a0fe80a6fa56400b4b8089accde21c7.tar.gz
qmk_firmware-362a65510a0fe80a6fa56400b4b8089accde21c7.zip
[Docs] Move QMK newbs build environment guide to next section (#15386)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
-rw-r--r--docs/newbs_building_firmware.md16
-rw-r--r--docs/newbs_getting_started.md16
2 files changed, 15 insertions, 17 deletions
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md
index ed94a1460..ed51a9aea 100644
--- a/docs/newbs_building_firmware.md
+++ b/docs/newbs_building_firmware.md
@@ -2,6 +2,20 @@
2 2
3Now 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. 3Now 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.
4 4
5## Configure Your Build Environment Defaults (Optional)
6
7You can configure your build environment to set the defaults and make working with QMK less tedious. Let's do that now!
8
9Most 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`:
10
11 qmk config user.keyboard=clueboard/66/rev4
12
13?> 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`.
14
15You can also set your default keymap name. Most people use their GitHub username like the keymap name from the previous steps:
16
17 qmk config user.keymap=<github_username>
18
5## Create a New Keymap 19## Create a New Keymap
6 20
7To 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: 21To 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
45 59
46 qmk compile 60 qmk compile
47 61
48If you did not configure your environment, or you have multiple keyboards, you can specify a keyboard and/or keymap: 62If you did not configure defaults for your environment, or you have multiple keyboards, you can specify a keyboard and/or keymap:
49 63
50 qmk compile -kb <keyboard> -km <keymap> 64 qmk compile -kb <keyboard> -km <keymap>
51 65
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 5dbaa5616..d6c080173 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
182 * The firmware size is fine - 26356/28672 (2316 bytes free) 182 * The firmware size is fine - 26356/28672 (2316 bytes free)
183``` 183```
184 184
185## 5. Configure Your Build Environment (Optional)
186
187You can configure your build environment to set the defaults and make working with QMK less tedious. Let's do that now!
188
189Most 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`:
190
191 qmk config user.keyboard=clueboard/66/rev4
192
193You can also set your default keymap name. Most people use their GitHub username here, and we recommend that you do too.
194
195 qmk config user.keymap=<github_username>
196
197The keyboard can now be compiled without arguments using the following command after creating your keymap in the next section:
198
199 qmk compile
200
201# Creating Your Keymap 185# Creating Your Keymap
202 186
203You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware.md) for that. 187You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware.md) for that.