keyboards/kc60/readme.md

   1 KC60 (version 2.0) keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5 For the full Quantum feature list, see [the parent readme.md](/readme.md).
   6
   7 ## Building
   8 Download or clone the whole firmware and navigate to the keyboards/kc60 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.
   9
  10 Depending on which keymap you would like to use, you will have to compile slightly differently.
  11
  12 ### Default
  13 To build with the default keymap, simply run `make`.
  14
  15 ### Other Keymaps
  16 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files.
  17
  18 To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
  19 ```
  20 $ make KEYMAP=[default|jack|<name>]
  21 ```
  22 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  23
  24 ## WS2812 Support
  25 ![Image of KC60 with RGB Underglow](keymaps/ws2812/ws2812_example.jpg)
  26
  27 Build with WS2812 Support by running `make KEYMAP=ws2812`.