summaryrefslogtreecommitdiffstats
path: root/keyboards/reviung5/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-07-06 22:20:51 +0000
committerQMK Bot <hello@qmk.fm>2021-07-06 22:20:51 +0000
commit0aa963c740012715c150731bf53d02f3dba6747b (patch)
tree0e55bc3a7224976a70d8d139b1c6366adf2eb720 /keyboards/reviung5/readme.md
parent2048c28f789e8942367bd7cca0d4d243784c7186 (diff)
parent09c4d536c31c7443c4355e749e72364262fdd454 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/reviung5/readme.md')
-rw-r--r--keyboards/reviung5/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/reviung5/readme.md b/keyboards/reviung5/readme.md
new file mode 100644
index 0000000000..990645649c
--- /dev/null
+++ b/keyboards/reviung5/readme.md
@@ -0,0 +1,19 @@
+# reviung5
+
+![reviung5](https://github.com/gtips/reviung/blob/master/reviung5/image/reviung5-1.jpg)
+
+The REVIUNG5 is 5-key (or 4-key + Rotary Encoder) macropad.
+
+* Keyboard Maintainer: [gtips](https://github.com/gtips)
+* Hardware Supported: REVIUNG5 PCB.
+* Hardware Availability: [PCB & Case Data](https://github.com/gtips/reviung/tree/master/reviung5)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make reviung5:default
+
+Flashing example for this keyboard:
+
+ make reviung5:default:flash
+
+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).