summaryrefslogtreecommitdiffstats
path: root/keyboards/kbd8x/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-05-08 11:38:11 -0700
committerDrashna Jaelre <drashna@live.com>2018-05-08 11:38:11 -0700
commit1b4ad6b4ae55a873cbe13ffde87544bae88f2b19 (patch)
tree5a592910e7aea1f987cd2a9e837660863d0bb430 /keyboards/kbd8x/readme.md
parentccc87421e77f554cac08d2f8b2c3cbcb04f6181c (diff)
KBD8X QMK Support (#2915)
* initial commit * add row/column and pin info * Add first part of switch matrix * documentation and additional config items * map out the non confusing part of the matrix * map out the top row * ok I think I got it * fix some stupid compile errors * put in a default keymap * rename LAYOUT to LAYOUT_all * add a standard layout and info.json file * Fix up readme for default keymap * Add toggle key LED functionality * changes based on review feedback
Diffstat (limited to 'keyboards/kbd8x/readme.md')
-rw-r--r--keyboards/kbd8x/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/kbd8x/readme.md b/keyboards/kbd8x/readme.md
new file mode 100644
index 0000000000..fe49819753
--- /dev/null
+++ b/keyboards/kbd8x/readme.md
@@ -0,0 +1,15 @@
+# KBD 8X
+
+![kbd8x](imgur.com image replace me!)
+
+TKL Keyboard from KBDFans
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: kbd8x
+Hardware Availability: [KBDFans](https://kbdfans.cn/blogs/updates/kbd-8x-update-40)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbd8x:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.