summaryrefslogtreecommitdiff
path: root/keyboards/handwired/reddot/readme.md
diff options
context:
space:
mode:
authordbroqua <dbroqua@mousur.org>2017-04-02 23:27:57 +0200
committerdbroqua <dbroqua@mousur.org>2017-04-02 23:27:57 +0200
commite7347ff0de93ff823462b3ff2b4136b44dc576c0 (patch)
tree286e2a78fee74eb370641a981d2c81c8e02942b4 /keyboards/handwired/reddot/readme.md
parent9e72b7e7e97f9ae92c7eb1de66aa03cad047baf6 (diff)
parent24ec8f509703cbaf9de7b41d251dbb7fcd339559 (diff)
Merge remote-tracking branch 'origin/master'
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.