]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/xd60/readme.md
Add user-overridable callback for cancelling UCIS input (#5564)
[qmk_firmware.git] / keyboards / xd60 / readme.md
index 393ea5d683bfecd5d8977a71422bb21b9418567d..b9862428c777a7e1fef3e8d4150f99e412010da9 100644 (file)
@@ -1,13 +1,21 @@
-# QMK Firmware for XIUDI's 60% XD60 PCB
+XD60
+==
 
-![Top View of XD60 Keyboard, with DSA Dolch keycaps](./top-view.JPG)
-![Angled View of XD60 Keyboard Arrow Cluster, with DSA Dolch keycaps](./arrow-cluster.JPG)
+Compact 60% with arrows.
 
-## Quantum MK Firmware
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+![Top View of a pair of XD60 Keyboard](https://i.imgur.com/3Jq2743.jpg)
 
-## 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.
+Keyboard Maintainer: QMK Community  
+Hardware Supported: XD60 PCB rev2 & rev3  
+Hardware Availability: https://www.massdrop.com/buy/xd60-xd64-custom-mechanical-keyboard-kit?mode=guest_open
 
-## Build
-To build the default keymap, simply run `make xd60-default`.
+With the implementation of Rev3 you need to specify the Rev you want to build.
+To build for a Rev2 with a default keymap:
+
+```make xd60/rev2:default```
+
+To build for a Rev3 with a default keymap:
+
+```make xd60/rev3:default```
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).