diff options
Diffstat (limited to 'keyboards/xd75/readme.md')
| -rw-r--r-- | keyboards/xd75/readme.md | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/keyboards/xd75/readme.md b/keyboards/xd75/readme.md index 0bc82be91e..28a2523324 100644 --- a/keyboards/xd75/readme.md +++ b/keyboards/xd75/readme.md @@ -9,22 +9,40 @@ For more info on this firmware (and how to make it your own), head over to [qmk. ## Building -Download or clone the whole firmware and navigate to the keyboards/xd75 folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. - -Depending on which keymap you would like to use, you will have to compile slightly differently. +Download or clone the whole firmware and navigate to the +keyboards/xd75 folder. Once your dev env is setup, you'll be able to +type `make` to generate your .hex - you can then use the Teensy Loader +to install the resulting .hex file, or have the `make` process install +it using DFU. ### Default -To build with the default keymap, simply run `make default`. +To build with the default keymap, simply run `make xd75-default`, and +to install via DFU, `make xd75-default-dfu`. + +Note that DFU is likely to require root permissions, so installing the +firmware likely requires a command line like: + +``` +$ sudo make xd75-default-dfu +``` ### Other Keymaps -The "default" keymap included is basically the OLKB Atomic keymap with a few buttons added for RGB underglow control. This should be usable as a starting point, but most people will be best served creating their own keymap and flashing it - more info on creating your own keymap is available in [the official QMK documentation](https://docs.qmk.fm). +The "default" keymap included is basically the OLKB Atomic keymap with +a few buttons added for RGB underglow control. This should be usable +as a starting point, but most people will be best served creating +their own keymap and flashing it - more info on creating your own +keymap is available in [the official QMK +documentation](https://docs.qmk.fm). + +Keymaps follow the format **__\<name\>.c__** and are stored in +subdirectories under `keyboards/xd75/keymaps` -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: +To build the firmware binary hex file for a specific keymap, and +install it, using DFU, just do `make` with a keymap like this: ``` -$ make [default|jack|<name>] +$ make xd75-[default|<name>] ``` -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |