From f3086b57e634dcc505e3b3c2d3fd0c225de352ea Mon Sep 17 00:00:00 2001 From: IBNobody Date: Wed, 1 Jun 2016 20:41:51 -0500 Subject: 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 --- keyboard/arrow_pad/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 keyboard/arrow_pad/README.md (limited to 'keyboard/arrow_pad/README.md') 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 `.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|] +``` +Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. \ No newline at end of file -- cgit v1.2.3