diff options
| author | IBNobody <IBNobody@users.noreply.github.com> | 2016-06-01 20:41:51 -0500 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-06-01 21:41:51 -0400 |
| commit | f3086b57e634dcc505e3b3c2d3fd0c225de352ea (patch) | |
| tree | bda78642eb0b734550eaab187be75921b4dc0cdb /keyboard/arrow_pad/README.md | |
| parent | 84276ee56145a705a278fd1137f8b945d27d0242 (diff) | |
| download | firmware-f3086b57e634dcc505e3b3c2d3fd0c225de352ea.tar.gz firmware-f3086b57e634dcc505e3b3c2d3fd0c225de352ea.tar.bz2 firmware-f3086b57e634dcc505e3b3c2d3fd0c225de352ea.zip | |
Submitting ArrowPad, A QMK-based 21/24 key keypad (#372)
* Created arrow pad, a QMK based numpad designed for heavy text editing
* Enabled backlighting, numlock indicator, and forced nkro for arrowpad
* WIP Arrowpad 21
* WIP Arrowpad 21
* Combined Arrow Pad 21 and 24
* Combined Arrow Pad 21 and 24
* Removed 21 folder
Diffstat (limited to 'keyboard/arrow_pad/README.md')
| -rw-r--r-- | keyboard/arrow_pad/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/arrow_pad/README.md b/keyboard/arrow_pad/README.md new file mode 100644 index 000000000..f669ad6a1 --- /dev/null +++ b/keyboard/arrow_pad/README.md @@ -0,0 +1,24 @@ +arrow_pad keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent README.md](/README.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboard/arrow_pad 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 file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files. + +To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: +``` +$ make KEYMAP=[default|jack|<name>] +``` +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
\ No newline at end of file |