diff options
author | milestogo <milestogo@users.noreply.github.com> | 2017-02-09 23:28:39 -0800 |
---|---|---|
committer | milestogo <milestogo@users.noreply.github.com> | 2017-02-09 23:28:39 -0800 |
commit | b0537f75df73ca5a55355c7546d45577cb2c6a38 (patch) | |
tree | 0da100dc4fcbe21629a10879b53e13d02c25c170 /keyboards/handwired/reddot/readme.md | |
parent | 5ac0e6e6aee64c9b8fade79aaf22bc839e2c6b47 (diff) | |
parent | 41c93575a838e9b201ca113165085f47198e109d (diff) |
Merge branch 'master' into sculpt2
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 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 `<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. |