diff options
author | Jack Humbert <jack.humb@gmail.com> | 2016-11-21 19:18:47 -0500 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2016-11-21 19:18:47 -0500 |
commit | 27ebacb15d39046713bd87e06c1157b1ffab6aaf (patch) | |
tree | 5a60417af07d3ff8798e371db210dd32ef10d332 /keyboards/maxipad/readme.md | |
parent | c1037b1dc060d14a09a59f697fefe2b5b91bf373 (diff) | |
parent | 3b990c08dcc0e57875e9220a5e6371f60679c7ae (diff) |
merging lets_split
Diffstat (limited to 'keyboards/maxipad/readme.md')
-rw-r--r-- | keyboards/maxipad/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md new file mode 100644 index 0000000000..ab7b122fe8 --- /dev/null +++ b/keyboards/maxipad/readme.md @@ -0,0 +1,28 @@ +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme](/). + + +## Building + +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. + +Depending on which keymap you would like to use, you will have to compile slightly differently. + +### Default + +To build with the default keymap, simply run `make`. + + +### Other Keymaps + +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. + +To build the firmware binary hex file with a keymap just do `make` with a keymap like this: + +``` +$ make [default|jack|<name>] +``` + +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. + |