aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/xd84/readme.md
diff options
context:
space:
mode:
authorGravatar zvecr <git@zvecr.com>2019-02-18 01:47:01 +0000
committerGravatar MechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-02-17 17:47:01 -0800
commit657d05593491f7d4d1346f0f06f9972fdbde9095 (patch)
tree8a41e8d1e95cc4afe721ce375bd46d46d671f2e5 /keyboards/xd84/readme.md
parent278a6c74f34784dde307d6d024aaea0e783c1f3f (diff)
downloadqmk_firmware-657d05593491f7d4d1346f0f06f9972fdbde9095.tar.gz
Inital port of xd84 (#5164)
* Inital port of xd84 * Inital port of xd84 - review comments
Diffstat (limited to 'keyboards/xd84/readme.md')
-rw-r--r--keyboards/xd84/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/xd84/readme.md b/keyboards/xd84/readme.md
new file mode 100644
index 000000000..38b4efcba
--- /dev/null
+++ b/keyboards/xd84/readme.md
@@ -0,0 +1,23 @@
+# XD84
+
+![XD84](https://cdn.shopify.com/s/files/1/2711/4238/products/HTB17eeJSXXXXXbIXFXXq6xXFXXXp_1024x1024.jpg?v=1515505994)
+
+Compact With 84 Keys & RGB LED Underglow
+- Designed by Xiudi
+- Up to 87 keys
+ - iso and ansi support
+- Uses Kimera core
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: XD84
+Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make xd84:default
+
+Install examples:
+
+ make xd84:default:dfu
+
+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).