keyboards/maxipad/readme.md

   1 <<<<<<< HEAD
   2 Maxipad keyboard firmware
   3 ======================
   4
   5 ## Quantum MK Firmware
   6
   7 For the full Quantum feature list, see [the parent readme.md](/readme.md).
   8 =======
   9 ## Quantum MK Firmware
  10
  11 For the full Quantum feature list, see [the parent readme](/).
  12
  13 >>>>>>> a06115df19a74d39b08758472b221e630c3680d3
  14
  15 ## Building
  16
  17 If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile
  18
  19 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.
  20
  21 Depending on which keymap you would like to use, you will have to compile slightly differently.
  22
  23 ### Default
  24 <<<<<<< HEAD
  25 To build with the default keymap, simply run `make default`.
  26 =======
  27
  28 To build with the default keymap, simply run `make`.
  29
  30 >>>>>>> a06115df19a74d39b08758472b221e630c3680d3
  31
  32 ### Other Keymaps
  33 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` and see keymap document (you can find in top readme.md) and existent keymap files.
  34
  35 <<<<<<< HEAD
  36 =======
  37 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.
  38
  39 >>>>>>> a06115df19a74d39b08758472b221e630c3680d3
  40 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  41
  42 ```
  43 $ make [default|jack|<name>]
  44 ```
  45 <<<<<<< HEAD
  46 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  47 =======
  48
  49 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  50
  51 >>>>>>> a06115df19a74d39b08758472b221e630c3680d3