diff options
author | Stanley Lai <stanleylai.sg@gmail.com> | 2017-02-13 12:36:22 -0800 |
---|---|---|
committer | Stanley Lai <stanleylai.sg@gmail.com> | 2017-02-13 12:36:22 -0800 |
commit | a8eba1bddaf55224939a86bfa4d8e1b53e1d82db (patch) | |
tree | 906568677ed027a807d5e9c0c1bc1c2ae001f0f6 /keyboards/handwired/reddot/readme.md | |
parent | 53ea854462c0b3b2c3c58a36b714ac02f773c74f (diff) | |
parent | fd2925efbac0d7963f3d267dd5264f08a0a4e9dc (diff) | |
download | qmk_firmware-a8eba1bddaf55224939a86bfa4d8e1b53e1d82db.tar.gz |
Merge remote-tracking branch 'refs/remotes/qmk/master'
Diffstat (limited to 'keyboards/handwired/reddot/readme.md')
-rwxr-xr-x | keyboards/handwired/reddot/readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/handwired/reddot/readme.md b/keyboards/handwired/reddot/readme.md new file mode 100755 index 000000000..11bcba54a --- /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 `<name>.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|<name>] +``` +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |