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`, and
  21 to install via DFU, `make xd75-default-dfu`.
  22
  23 Note that DFU is likely to require root permissions, so installing the
  24 firmware likely requires a command line like:
  25
  26 ```
  27 $ sudo make xd75-default-dfu
  28 ```
  29
  30 ### Other Keymaps
  31
  32 The "default" keymap included is basically the OLKB Atomic keymap with
  33 a few buttons added for RGB underglow control. This should be usable
  34 as a starting point, but most people will be best served creating
  35 their own keymap and flashing it - more info on creating your own
  36 keymap is available in [the official QMK
  37 documentation](https://docs.qmk.fm).
  38
  39 Keymaps follow the format **__\<name\>.c__** and are stored in
  40 subdirectories under `keyboards/xd75/keymaps`
  41
  42 To build the firmware binary hex file for a specific keymap, and
  43 install it, using DFU, just do `make` with a keymap like this:
  44
  45 ```
  46 $ make xd75-[default|<name>]
  47 ```
  48