quantum/template/readme.md

   1 %KEYBOARD% keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5
   6 For the full Quantum feature list, see [the parent readme](/).
   7
   8 ## Building
   9
  10 Download or clone the whole firmware and navigate to the root folder. Once your dev env is setup, you'll be able to type `make %KEYBOARD%-default` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
  11
  12 (Note: replace %KEYBOARD% with the name of your keyboard.)
  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 %KEYBOARD%-default`.
  19
  20 ### Other Keymaps
  21
  22 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder. Create a `readme.md` and a `keymap.c` file to complete your new keymap. When you are done your file tree should look like this:
  23
  24 * `qmk_firmware/`
  25   * `keyboard/`
  26     * `keymaps/`
  27       * `config.h` (optional)
  28       * `keymap.c`
  29       * `readme.md`
  30       * `rules.mk` (optional)
  31
  32 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  33
  34 ```
  35 $ make %KEYBOARD%-[default|jack|<name>]
  36 ```