summaryrefslogtreecommitdiff
path: root/keyboards/uno/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/uno/readme.md')
-rw-r--r--keyboards/uno/readme.md35
1 files changed, 25 insertions, 10 deletions
diff --git a/keyboards/uno/readme.md b/keyboards/uno/readme.md
index ce4cccd196..b60ef23e97 100644
--- a/keyboards/uno/readme.md
+++ b/keyboards/uno/readme.md
@@ -1,19 +1,34 @@
-# uno
+# Uno
- ![uno](https://i.imgur.com/OqPyWbbl.jpg)
+![Uno](https://i.imgur.com/OqPyWbbl.jpg)
A 1-key, in-USB "board" for the lulz
- * Keyboard Maintainer: [Snipeye](https://github.com/Snipeye)
- * Hardware Supported: uno pcb
- * Hardware Availability: [GB](https://www.reddit.com/r/mechmarket/comments/gyijm7/gb_uno/)
+* Keyboard Maintainer: [Snipeye](https://github.com/Snipeye)
+* Hardware Availability: [keyhive.xyz](https://keyhive.xyz/shop/uno-single-key-keyboard)
- Make example for this keyboard (after setting up your build environment):
+There are two revisions of Uno. If your Uno supports a rotary encoder, use rev2.
+If it *does not* support a rotary encoder, use rev1. The following examples use
+`rev2` — be sure to change this if you are using `rev1`.
- make uno:default
+Make example for this keyboard (after setting up your build environment; make
+sure to change `rev2` to your Uno's version):
- Flashing example for this keyboard:
+ make uno/rev2:default
- make uno:default:flash
+Flashing example for this keyboard (change `rev2` to `rev1` if needed):
- 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).
+ make uno/rev2:default:flash
+
+If you prefer to use the `qmk` tool:
+
+ qmk compile -kb uno/rev2 -km default
+
+Create your own keymap with:
+
+ qmk new-keymap -kb uno/rev2
+
+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).
+
+### Credits
++ Everything by Snipeye