summaryrefslogtreecommitdiffstats
path: root/keyboards/kbd4x/readme.md
diff options
context:
space:
mode:
authorRebecca Le <543859+sevenseacat@users.noreply.github.com>2018-10-02 11:43:43 +0800
committerDrashna Jaelre <drashna@live.com>2018-10-01 20:43:43 -0700
commit9f2e39732f2458b1bfe5d546581da508c2be577e (patch)
treeaee0020e68c872ec50102731b33523db2af26a1a /keyboards/kbd4x/readme.md
parentabcf64ecbdadc226350d457dfdc5079ce51fd72c (diff)
Keyboard: Add support for the KBD4x (#4036)
* Generate a new project for the KBD4x * Specify the possible layouts for the KBD4x - MIT and grid * Fill out the readme for the KBD4x * Configure the default keymap and wiring configuration as specified on http://qmkeyboard.cn/ * Add info.json for QMK Configurator * Enable backlight support for the KBD4x * Standardise on LAYOUT_planck_mit/LAYOUT_ortho_4x12 layout names * Add whitespace so the Readme will render correctly * Disable mouse keys support for the KBD4x to make the firmware small enough
Diffstat (limited to 'keyboards/kbd4x/readme.md')
-rw-r--r--keyboards/kbd4x/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/kbd4x/readme.md b/keyboards/kbd4x/readme.md
new file mode 100644
index 0000000000..42dc450248
--- /dev/null
+++ b/keyboards/kbd4x/readme.md
@@ -0,0 +1,15 @@
+# KBD4x
+
+![KBD4x](https://cdn.shopify.com/s/files/1/1473/3902/products/1_ef8d3ad0-fc70-4d4f-9e36-8438c781a581_1800x1800.jpg)
+
+A compact 40% (12x4) ortholinear keyboard kit sold by KBDFans.
+
+Keyboard Maintainer: ![sevenseacat](https://github.com/sevenseacat)
+Hardware Supported: KBD4x PCB
+Hardware Availability: https://kbdfans.cn/collections/diy-kit/products/kbd4x-custom-mechanical-keyboard-hot-swap-diy-kit
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbd4x: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).