aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs_building_firmware.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/newbs_building_firmware.md')
-rw-r--r--docs/newbs_building_firmware.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md
index de9217e9f0..5e6a4452df 100644
--- a/docs/newbs_building_firmware.md
+++ b/docs/newbs_building_firmware.md
@@ -10,7 +10,9 @@ Most people new to QMK only have 1 keyboard. You can set this keyboard as your d
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`.
+::: tip
+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:
@@ -40,20 +42,24 @@ Open your `keymap.c` file in your text editor. Inside this file you'll find the
This line indicates where the list of Layers begins. Below that you'll find lines containing `LAYOUT`, and these lines indicate the start of a layer. Below that line is the list of keys that comprise a particular layer.
-!> When editing your keymap file be careful not to add or remove any commas. If you do, you will prevent your firmware from compiling and it may not be easy to figure out where the extra, or missing, comma is.
+::: warning
+When editing your keymap file be careful not to add or remove any commas. If you do, you will prevent your firmware from compiling and it may not be easy to figure out where the extra, or missing, comma is.
+:::
## Customize The Layout To Your Liking
How to complete this step is entirely up to you. Make the one change that's been bugging you, or completely rework everything. You can remove layers if you don't need all of them, or add layers up to a total of 32. There are a lot of features in QMK, explore the sidebar to the left under "Using QMK" to see the full list. To get you started here are a few of the easier to use features:
-* [Basic Keycodes](keycodes_basic.md)
-* [Quantum Keycodes](quantum_keycodes.md)
-* [Grave/Escape](feature_grave_esc.md)
-* [Mouse keys](feature_mouse_keys.md)
+* [Basic Keycodes](keycodes_basic)
+* [Quantum Keycodes](quantum_keycodes)
+* [Grave/Escape](feature_grave_esc)
+* [Mouse keys](feature_mouse_keys)
-?> While you get a feel for how keymaps work, keep each change small. Bigger changes make it harder to debug any problems that arise.
+::: tip
+While you get a feel for how keymaps work, keep each change small. Bigger changes make it harder to debug any problems that arise.
+:::
-## Build Your Firmware :id=build-your-firmware
+## Build Your Firmware {#build-your-firmware}
When your changes to the keymap are complete you will need to build the firmware. To do so go back to your terminal window and run the compile command:
@@ -75,4 +81,4 @@ Checking file size of planck_rev5_default.hex
## Flash Your Firmware
-Move on to [Flashing Firmware](newbs_flashing.md) to learn how to write your new firmware to your keyboard.
+Move on to [Flashing Firmware](newbs_flashing) to learn how to write your new firmware to your keyboard.