aboutsummaryrefslogtreecommitdiff
path: root/keyboards/kbd4x/readme.md
diff options
context:
space:
mode:
authorAlex Ong <[email protected]>2019-01-04 19:39:14 +1100
committerAlex Ong <[email protected]>2019-01-04 19:39:14 +1100
commit47c91fc7f75ae0a477e55b687aa0fc30da0a283c (patch)
tree65ad39452748ff2e6d4a83ce54ede6ca22c9ada9 /keyboards/kbd4x/readme.md
parentac9b88e8ccbbf38762871504cd827ff0d941c426 (diff)
parent563ce3f225d981ce460c12ca5130dfe47af41df0 (diff)
downloadqmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.gz
qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.zip
Merge branch 'master' of https://github.com/qmk/qmk_firmware
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).