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.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md
index f227d623f..fabfefb19 100644
--- a/docs/newbs_building_firmware.md
+++ b/docs/newbs_building_firmware.md
@@ -16,12 +16,26 @@ Start by navigating to the `keymaps` folder for your keyboard.
16 16
17?> Windows: 17?> Windows:
18 18
19 start keyboards/<keyboard_folder>/keymaps 19 start .\\keyboards\\<keyboard_folder>\\keymaps
20 20
21## Create a Copy Of The `default` Keymap 21## Create a Copy Of The `default` Keymap
22 22
23Once you have the `keymaps` folder open you will want to create a copy of the `default` folder. We highly recommend you name your folder the same as your GitHub username, but you can use any name you want as long as it contains only lower case letters, numbers, and the underscore character. 23Once you have the `keymaps` folder open you will want to create a copy of the `default` folder. We highly recommend you name your folder the same as your GitHub username, but you can use any name you want as long as it contains only lower case letters, numbers, and the underscore character.
24 24
25To automate the process, you also have the option to run the `new_keymap.sh` script.
26
27Navigate to the `qmk_firmware/util` directory and type the following:
28
29```
30./new_keymap.sh <keyboard path> <username>
31```
32
33For example, for a user named John, trying to make a new keymap for the 1up60hse, they would type in
34
35```
36./new_keymap.sh 1upkeyboards/1up60hse john
37```
38
25## Open `keymap.c` In Your Favorite Text Editor 39## Open `keymap.c` In Your Favorite Text Editor
26 40
27Open up your `keymap.c`. Inside this file you'll find the structure that controls how your keyboard behaves. At the top of `keymap.c` there may be some defines and enums that make the keymap easier to read. Farther down you'll find a line that looks like this: 41Open up your `keymap.c`. Inside this file you'll find the structure that controls how your keyboard behaves. At the top of `keymap.c` there may be some defines and enums that make the keymap easier to read. Farther down you'll find a line that looks like this: