keyboards/handwired/fivethirteen/README.md

   1 fivethirteen keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5
   6 For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
   7
   8 ## Building
   9
  10 Download or clone the whole firmware and navigate to the keyboards/handwired/fivethirteen folder.
  11 Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use
  12 the Teensy Loader to program your .hex file.
  13
  14 Depending on which keymap you would like to use, you will have to compile slightly differently.
  15
  16 ### Default
  17
  18 To build with the default keymap, simply run `make`.
  19
  20 ### Other Keymaps
  21
  22 To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
  23
  24 ```
  25 $ make keymap=[default|jack|<name>]
  26 ```
  27
  28 Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`