summaryrefslogtreecommitdiffstats
path: root/keyboards/xd75/readme.md
diff options
context:
space:
mode:
authorBenjamin Kesselring <benji@Benjamins-MacBook-Pro.local>2017-07-29 22:22:09 +0200
committerJack Humbert <jack.humb@gmail.com>2017-07-30 06:46:08 +0200
commit992a63c0f29d167341cb2417d2bc90302abe51d8 (patch)
treed1315d7c7ae7e245dedd5e8d5c92baa840bd0067 /keyboards/xd75/readme.md
parent25659acb1c8c0357e1acc581a49b917b4001b611 (diff)
downloadqmk_firmware-992a63c0f29d167341cb2417d2bc90302abe51d8.tar.gz
qmk_firmware-992a63c0f29d167341cb2417d2bc90302abe51d8.tar.xz
add xd75, preliminary RGB'
Diffstat (limited to 'keyboards/xd75/readme.md')
-rw-r--r--keyboards/xd75/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/xd75/readme.md b/keyboards/xd75/readme.md
new file mode 100644
index 000000000..126320872
--- /dev/null
+++ b/keyboards/xd75/readme.md
@@ -0,0 +1,28 @@
+xd75 keyboard firmware
+======================
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent readme](/).
+
+## Building
+
+Download or clone the whole firmware and navigate to the keyboards/xd75 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 default`.
+
+### 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 a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+
+To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
+
+```
+$ make [default|jack|<name>]
+```
+
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.