summaryrefslogtreecommitdiffstats
path: root/keyboards/zen/readme.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2018-08-17 16:04:21 -0700
committerDrashna Jaelre <drashna@live.com>2018-08-17 16:04:21 -0700
commit8007d9f3a7583adeedd26fa7ab1622e06fed8034 (patch)
tree5fb7089981ba63d2823e0ba4fbf65fa0de79ee20 /keyboards/zen/readme.md
parentda24a34efbfdeb80190b78f3f59451af86c4fb8b (diff)
Keyboard: Zen refactor and Configurator support (#3677)
* Matrix refactor * Keymap refactor * Configurator support * Readme reformatting
Diffstat (limited to 'keyboards/zen/readme.md')
-rw-r--r--keyboards/zen/readme.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/keyboards/zen/readme.md b/keyboards/zen/readme.md
index 36c63d2933..beb5e13ac1 100644
--- a/keyboards/zen/readme.md
+++ b/keyboards/zen/readme.md
@@ -1,12 +1,20 @@
-Zen Keyboard
-====
+# Zen Keyboard
A split ergo keyboard with a few goals in mind:
- - Be as thin as possible. Other split KBs (Let's Split, Nyquist, Iris) are 15.2mm thick. The Zen is only 8.0mm thick.
- - Layout designed for gaming. 1.5u pinky keys, ortho alphas, and angled thumb keys. After trying Ortholiniear, Atreus62, and Ergodox, this is the best layout for gaming and typing.
- - RGB backlighting. 16 WS2812b LEDs shine through the perimeter switches. The SK6812 variant are cheap and easy to solder.
- - Price. Using Arduino Pro Micro, SK6812 LEDs, and PCB FR4 for the case, the cost of each half without switches or caps can be reduced to under $20 when purchased at volume.
-A build guide and more info for this keyboard can be found here: [Zen Build Guide](https://legonut.gitbooks.io/zen-keyboard/content/)
+- Be as thin as possible. Other split KBs (Let's Split, Nyquist, Iris) are 15.2mm thick. The Zen is only 8.0mm thick.
+- Layout designed for gaming. 1.5u pinky keys, ortho alphas, and angled thumb keys. After trying Ortholinear, Atreus62, and Ergodox, this is the best layout for gaming and typing.
+- RGB backlighting. 16 WS2812b LEDs shine through the perimeter switches. The SK6812 variant are cheap and easy to solder.
+- Price. Using Arduino Pro Micro, SK6812 LEDs, and PCB FR4 for the case, the cost of each half without switches or caps can be reduced to under $20 when purchased at volume.
-Maintained by u/legonut3 \ No newline at end of file
+Keyboard Maintainer: [Legonut](https://github.com/Legonut)
+Hardware Supported: Zen rev1
+Hardware Availability: [RGBKB.net](https://www.rgbkb.net/)
+
+A build guide and more info for this keyboard can be found here: [Zen Build Guide](https://legonut.gitbooks.io/zen-keyboard/content/).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make zen/rev1: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.