diff options
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 @@ | |||
| 1 | ## RedDot Specific Info ## | ||
| 2 | |||
| 3 | |||
| 4 | ## Quantum MK Firmware | ||
| 5 | |||
| 6 | For the full Quantum feature list, see [the parent README.md](/README.md). | ||
| 7 | |||
| 8 | ## Building | ||
| 9 | |||
| 10 | 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. | ||
| 11 | |||
| 12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| 13 | |||
| 14 | ### Default | ||
| 15 | To build with the default keymap, simply run `make`. | ||
| 16 | |||
| 17 | ### Other Keymaps | ||
| 18 | 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. | ||
| 19 | |||
| 20 | To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: | ||
| 21 | ``` | ||
| 22 | $ make KEYMAP=[default|jack|<name>] | ||
| 23 | ``` | ||
| 24 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||
