aboutsummaryrefslogtreecommitdiff
path: root/keyboards/jian/readme.md
diff options
context:
space:
mode:
authorKgOfHedgehogs <[email protected]>2020-06-18 04:17:30 +0200
committerGitHub <[email protected]>2020-06-17 19:17:30 -0700
commit157319fbd03e6f7a6618111fd03ab3e53317893e (patch)
tree93ca9aab1d065325d22b939f4814eeda4544fc25 /keyboards/jian/readme.md
parent39ff121d7389fd6575e65ecb54b11bb87777ca38 (diff)
downloadqmk_firmware-157319fbd03e6f7a6618111fd03ab3e53317893e.tar.gz
qmk_firmware-157319fbd03e6f7a6618111fd03ab3e53317893e.zip
[Keyboard] Jian keyboard (#8914)
Co-authored-by: Joel Challis <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Ryan <[email protected]> Co-authored-by: Nick Brassel <[email protected]>
Diffstat (limited to 'keyboards/jian/readme.md')
-rw-r--r--keyboards/jian/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/jian/readme.md b/keyboards/jian/readme.md
new file mode 100644
index 0000000000..7afff2ab70
--- /dev/null
+++ b/keyboards/jian/readme.md
@@ -0,0 +1,16 @@
+# Jian
+
+<img src="https://i.imgur.com/XUzcaWG.png" data-canonical-src="Jian" width="600"/>
+
+A 40% ergonomic keyboard kit. Jian supports cherry mx, alps, kailh choc switches PCB and plate mounted. You can assembly keyboard without mounting plate. Jian also supports rgb led strip like ws2812b and 1 color in-switch backlight. Each half can work standalone.
+
+* Keyboard Maintainer: [KGOH](https://github.com/KGOH)
+* Hardware Supported: Jian PCB rev1, rev2, Pro Micro
+* Layout: [keyboard-layout-editor.com](http://www.keyboard-layout-editor.com/#/gists/4b6c2af67148f58ddd6c6b2976c4370f)
+* Hardware Availability: [Telegram channel](https://t.me/KgOfHedgehogs)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jian/rev2: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).