diff options
| author | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2018-09-13 11:22:05 -0700 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-09-13 11:22:05 -0700 |
| commit | 170de1273cde78d93b3f955aca133a4d690742b2 (patch) | |
| tree | c09f2b382ae7f7bbb22fa23963a8d1dbca4c48d7 /docs | |
| parent | 6d6d91c834ef3415425e21d895d4ec91c67fd4b8 (diff) | |
Add an easy way to create new keymaps for your favorite keyboard (#3868)
* initial commit of keymap creation script
* create default keymap
* pass shellcheck
* provide a better usage message
* change printf string to more accurately reflect the path
* make it more easily understood
* found another typo
* add documentation regarding the new_keymap script
* enforce lowercase for userinputs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/newbs_building_firmware.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md index f227d623f0..ac6bff2bc7 100644 --- a/docs/newbs_building_firmware.md +++ b/docs/newbs_building_firmware.md @@ -22,6 +22,20 @@ Start by navigating to the `keymaps` folder for your keyboard. Once 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. +To automate the process, you also have the option to run the `new_keymap.sh` script. + +Navigate to the `qmk_firmware/util` directory and type the following: + +``` +./new_keymap.sh <keyboard path> <username> +``` + +For example, for a user named John, trying to make a new keymap for the 1up60hse, they would type in + +``` +./new_keymap.sh 1upkeyboards/1up60hse john +``` + ## Open `keymap.c` In Your Favorite Text Editor Open 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: |