From f36fc1d2e534b23bfd9794dab85859f6a9fbeb18 Mon Sep 17 00:00:00 2001 From: upils Date: Tue, 31 Jan 2017 22:37:03 +0100 Subject: Add reddot handwired keyboard. --- keyboards/handwired/reddot/readme.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100755 keyboards/handwired/reddot/readme.md (limited to 'keyboards/handwired/reddot/readme.md') diff --git a/keyboards/handwired/reddot/readme.md b/keyboards/handwired/reddot/readme.md new file mode 100755 index 0000000000..11bcba54ad --- /dev/null +++ b/keyboards/handwired/reddot/readme.md @@ -0,0 +1,24 @@ +## RedDot Specific Info ## + + +## 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/reddot 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` 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. -- cgit v1.2.1