summaryrefslogtreecommitdiff
path: root/keyboards/handwired/reddot/readme.md
diff options
context:
space:
mode:
authorTerryMathews <terry@terrymathews.net>2017-04-08 00:30:54 -0400
committerGitHub <noreply@github.com>2017-04-08 00:30:54 -0400
commit3899bec4b603a0880055c60df534c5a86ad44a52 (patch)
treedd3ac70f403290fafff4bf8005925a3d5eed69cd /keyboards/handwired/reddot/readme.md
parent2a2be010d9d8c10d872c01637f4b4cd263f9bc1b (diff)
parent154305ce1be16b2c8abce5e5d4dee421f295d6b3 (diff)
Merge pull request #1 from qmk/master
Catchup
Diffstat (limited to 'keyboards/handwired/reddot/readme.md')
-rwxr-xr-xkeyboards/handwired/reddot/readme.md24
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.