keyboards/maxipad/readme.md

   1 maxipad keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5
   6 <<<<<<< HEAD
   7 For the full Quantum feature list, see [the parent readme](/).
   8 =======
   9 For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
  10 >>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
  11
  12 ## Building
  13
  14 Download or clone the whole firmware and navigate to the keyboards/maxipad 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.
  15
  16 Depending on which keymap you would like to use, you will have to compile slightly differently.
  17
  18 ### Default
  19
  20 <<<<<<< HEAD
  21 To build with the default keymap, simply run `make default`.
  22 =======
  23 To build with the default keymap, simply run `make`.
  24 >>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
  25
  26 ### Other Keymaps
  27
  28 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, and see keymap documentation (you can find in top readme.md) and existant keymap files.
  29
  30 <<<<<<< HEAD
  31 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  32
  33 ```
  34 $ make [default|jack|<name>]
  35 ```
  36
  37 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  38 =======
  39 To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
  40
  41 ```
  42 $ make keymap=[default|jack|<name>]
  43 ```
  44
  45 Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
  46 >>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df