diff options
author | Xyverz <xyverz@gmail.com> | 2017-02-10 23:34:27 -0800 |
---|---|---|
committer | Xyverz <xyverz@gmail.com> | 2017-02-10 23:34:27 -0800 |
commit | 902d5077cd54f3a964e3276d7858212d975818ec (patch) | |
tree | cddf5a379614f421908bbe57ae5d396cc1e2ed37 /keyboards/handwired/reddot/readme.md | |
parent | 4d7105c2cf47c7604b54cdf488b4eb9d08c1f1cf (diff) | |
parent | 835556da9111d91b71c545d6a273e843f07631ae (diff) |
Merge remote-tracking branch 'upstream/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 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. |