summaryrefslogtreecommitdiffstats
path: root/keyboards/the_uni/readme.md
diff options
context:
space:
mode:
authorlokher <lokher@gmail.com>2022-12-06 17:04:10 +0800
committerlokher <lokher@gmail.com>2022-12-06 17:04:10 +0800
commit27fc28fd2ff52e079a5bc58d6aaea4c752420615 (patch)
tree7ac943fb1ba4f430a7220efd18f66f6a77205c30 /keyboards/the_uni/readme.md
parente736133392fe6427cfb995da0787337189828272 (diff)
parent2709b6ed616f8012ff4cfd3ee69a822a8d188351 (diff)
Merge upstream master
Diffstat (limited to 'keyboards/the_uni/readme.md')
-rw-r--r--keyboards/the_uni/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/the_uni/readme.md b/keyboards/the_uni/readme.md
new file mode 100644
index 0000000000..88cb81b111
--- /dev/null
+++ b/keyboards/the_uni/readme.md
@@ -0,0 +1,36 @@
+# The Uni
+
+​
+![Layout](https://docs.stenokeyboards.com/images/uni-layout.png)
+![The Uni v2](https://github.com/petercpark/The_Uni/blob/main/Pics/uni%20v2/uni-v2.JPG?raw=true)
+
+A compact unibody split ortholinear keyboard made specifically for stenography.
+
+- Keyboard Maintainer: [Peter](https://github.com/petercpark)
+- Link to Keyboard Files (pro_micro version): [https://github.com/petercpark/The_Uni](https://github.com/petercpark/The_Uni)
+- Hardware Supported:
+
+ - The Uni v1 and v2 (pro_micro)
+ - The Uni v3 (usb_c)
+
+- Hardware Availability: [https://www.stenokeyboards.com](https://www.stenokeyboards.com)
+
+# Bootloader
+
+Enter the bootloader by:
+
+- **Physical reset button**: On the Uni v3, briefly press the button on the back of the PCB.
+- **Reset Pads**: Uni v1 and v2 have pins/pads you must short instead (RST to GND).
+
+Make examples for this keyboard (after setting up your build environment):
+
+ # version 1 and 2
+ make the_uni/pro_micro:default
+
+ # version 3
+ make the_uni/usb_c:default
+
+ # version 4
+ qmk compile -kb the_uni/rp_2040 -km 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).