summaryrefslogtreecommitdiffstats
path: root/keyboards/xd96/readme.md
diff options
context:
space:
mode:
authorzvecr <git@zvecr.com>2019-03-14 22:22:50 +0100
committerDrashna Jaelre <drashna@live.com>2019-03-14 22:22:50 +0100
commit577e99f1954347380dcde6f7160d95c6a38677d5 (patch)
treef5bddeef9d461a606a42fedd12bdfb1b33560e7d /keyboards/xd96/readme.md
parentc02c7b75171cf1038a249872806fc6ee926d79b8 (diff)
downloadqmk_firmware-577e99f1954347380dcde6f7160d95c6a38677d5.tar.gz
qmk_firmware-577e99f1954347380dcde6f7160d95c6a38677d5.tar.xz
[Keyboard] Inital port of xd96 (#5401)
* Initial import of xd96 based on xd84 code * Configure xd96 port expander mapping * Fix xd96 led count * Fix xd96 port expander reading * Fix xd96 port expander reading * Fix xd96 LAYOUT matrix mapping * Add additional links for xd96 Hardware Availability * Correct Configurator config Co-Authored-By: zvecr <git@zvecr.com> * Readme review comments Co-Authored-By: zvecr <git@zvecr.com>
Diffstat (limited to 'keyboards/xd96/readme.md')
-rw-r--r--keyboards/xd96/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/xd96/readme.md b/keyboards/xd96/readme.md
new file mode 100644
index 000000000..237d7a051
--- /dev/null
+++ b/keyboards/xd96/readme.md
@@ -0,0 +1,22 @@
+# XD96
+
+![XD96](https://cdn.shopify.com/s/files/1/2711/4238/products/xd96_pcb_1024x1024.jpg?v=1515425370)
+
+Compact With 96 Keys & RGB LED Underglow
+- Designed by Xiudi
+- ISO and ANSI support
+- Uses Kimera core
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: XD96
+Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd96-pcb-90-custom-mechanical-keyboard-supports-tkg-tools-underglow-rgb-programmed); [AliExpress](https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make xd96:default
+
+Install examples:
+
+ make xd96: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).