keyboards/xd75/readme.md

   1 xd75 keyboard firmware
   2 ======================
   3
   4 The XD75Re is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. This port of the QMK firmware is my first shot at using QMK, so if you see any features done wrong (or just plain missing), feel free to fix them and put in a pull request!
   5
   6 ## Quantum MK Firmware
   7
   8 For more info on this firmware (and how to make it your own), head over to [qmk.fm](http://qmk.fm).
   9
  10 ## Building
  11
  12 Download or clone the whole firmware and navigate to the
  13 keyboards/xd75 folder. Once your dev env is setup, you'll be able to
  14 type `make` to generate your .hex - you can then use the Teensy Loader
  15 to install the resulting .hex file, or have the `make` process install
  16 it using DFU.
  17
  18 ### Default
  19
  20 To build with the default keymap, simply run `make xd75:default` from the root directory (i.e. two levels above this file), and to install via DFU, `make xd75:default:dfu`, also from the root directory.
  21
  22 Note that DFU is likely to require root permissions, so installing the
  23 firmware likely requires a command line like:
  24
  25 ```
  26 $ sudo make xd75:default:dfu
  27 ```
  28
  29 ### Other Keymaps
  30
  31 The "default" keymap included is basically the OLKB Atomic keymap with
  32 a few buttons added for RGB underglow control. This should be usable
  33 as a starting point, but most people will be best served creating
  34 their own keymap and flashing it - more info on creating your own
  35 keymap is available in [the official QMK
  36 documentation](https://docs.qmk.fm).
  37
  38 Keymaps follow the format **__\<name\>.c__** and are stored in
  39 subdirectories under `keyboards/xd75/keymaps`
  40
  41 To build the firmware binary hex file for a specific keymap, and
  42 install it, using DFU, just do `make` with a keymap like this:
  43
  44 ```
  45 $ make xd75:[default|<name>]
  46 ```
  47