summaryrefslogtreecommitdiff
path: root/keyboards/xd60/readme.md
diff options
context:
space:
mode:
authorZay9502017-03-29 12:00:38 -0700
committerGitHub2017-03-29 12:00:38 -0700
commit2366ebfbbdeb6ec29cc9a0facda44d666305dd6e (patch)
tree883efed0b7260f3143f5a2a879bc3844a8255e0b /keyboards/xd60/readme.md
parent80c5ada3394c5ad8087df00ef878eb2cbcd87d70 (diff)
parent942f2ccee44bdb2e251553e9730cd8d59307d8b2 (diff)
Merge branch 'master' into to_push
Diffstat (limited to 'keyboards/xd60/readme.md')
-rw-r--r--keyboards/xd60/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/xd60/readme.md b/keyboards/xd60/readme.md
new file mode 100644
index 000000000..224498caa
--- /dev/null
+++ b/keyboards/xd60/readme.md
@@ -0,0 +1,17 @@
+# QMK Firmware for XIUDI's 60% XD60 PCB
+
+![Top View of a pair of XD60 Keyboard](./xd60.JPG)
+
+## Quantum MK Firmware
+For the full Quantum feature list, see [the parent readme.md](/readme.md).
+
+## Additional Notes
+The XD60 is essentially a GH60 rev. C, with support for a right-hand arrow cluster. Includes full compatibility with GH60 expansion boards. Board also supports in-switch LEDs (two-pin, single colour), as well as WS2182 LED strips for underglow lighting. Default keymap included, matching configuration on sale page.
+
+Version 2 PCBs include 6 soldered on RGB underglow LEDs on the bottom, and are labelled "XD60v2" on the top. They are otherwise identical to v1 PCBs.
+
+## Known Issues
+In-switch backlight LEDs seem to only support 1 brightness level.
+
+## Build
+To build the default keymap, simply run `make xd60-default`.