diff options
author | Jack Humbert <jack.humb@gmail.com> | 2017-02-07 12:20:29 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-02-07 12:20:29 -0500 |
commit | c256ad51bd36512740906c6d43bbaa622255f9e3 (patch) | |
tree | 0c4e14f5a2c96dc6c244f99da3ca3129b03d5fa9 /keyboards/handwired/reddot/readme.md | |
parent | 790dab27b6b515327e9f543d56b6233eeeba9e9a (diff) | |
parent | f36fc1d2e534b23bfd9794dab85859f6a9fbeb18 (diff) |
Merge pull request #1056 from upils/master
Add reddot handwired keyboard.
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. |