summaryrefslogtreecommitdiffstats
path: root/keyboards/3w6/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/3w6/readme.md')
-rw-r--r--keyboards/3w6/readme.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/3w6/readme.md b/keyboards/3w6/readme.md
new file mode 100644
index 0000000000..5878376bde
--- /dev/null
+++ b/keyboards/3w6/readme.md
@@ -0,0 +1,45 @@
+# 3W6
+
+![3W6](https://raw.githubusercontent.com/weteor/3W6/main/images/3w6_rev2_1s.jpg)
+
+The 3w6 is a low profile, split ortholinear keyboard with 36 keys.
+
+I needed a keyboard for work and wasn't really satisfied with the available alternatives (namely Corne, Kyria and Ferris), mostly because they are either rather large and/or don't have the spacing I would like.
+
+The 3w6 is designed to be a simple, realiable, cheap and small keyboard to be taken everywhere.
+
+There are currently two revisions:
+* Rev1:
+ - onboard microcontroller (ATMega32U4)
+ - USB-C connector Board <-> PC
+ - USB-C connectors between both split halfs
+ - choc spacing (18x17mm)
+ - aggressive pinky stagger
+ - support for Choc V1 switches
+* Rev2:
+ - everything Rev1 did
+ - additional middle plate (2mm)
+ - support for [Pimoroni Trackball](https://shop.pimoroni.com/products/trackball-breakout) instead of outer thumb switch on right half, needs midplate
+ - mounting holes for [Tenting Puck](https://splitkb.com/collections/keyboard-parts/products/tenting-puck), only usable without mid or switchplate
+
+---
+
+* Keyboard Maintainer: [weteor](https://github.com/weteor)
+* Hardware Supported:
+ * 3w6 rev1
+ * 3w6 rev2 (with Pimoroni support)
+* Hardware Availability:
+ * make one yourself: [Design and Productionfiles](https://github.com/weteor/3w6)
+ * maintainer is selling kits when available
+---
+To reach the bootloader, connect the board to the PC and push the reset button on left half.
+
+Make examples for this keyboard (after setting up your build environment):
+
+ make 3w6/rev1:default
+ make 3w6/rev2:default
+ make 3w6/rev2:default_pimoroni
+
+ ---
+
+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).