summaryrefslogtreecommitdiffstats
path: root/keyboards/iriskeyboards/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/iriskeyboards/readme.md')
-rw-r--r--keyboards/iriskeyboards/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/iriskeyboards/readme.md b/keyboards/iriskeyboards/readme.md
new file mode 100644
index 0000000000..615978f25d
--- /dev/null
+++ b/keyboards/iriskeyboards/readme.md
@@ -0,0 +1,21 @@
+# iriskeyboards
+
+![IrisRev0](https://i.imgur.com/sCrZ43rh.jpg)
+
+Iris Rev0 is an experimental keyboard with a unique gasket-style mounting option which offers a different kind of feel, as typical PORON and rubber gaskets are much harder.
+
+A few different layouts are supported such as 7u bottom row, ISO support, split backspace and right-shift.
+
+* Keyboard Maintainer: [SonOfAres](https://github.com/SonOfAres)
+* Hardware Supported: All Iris Rev0.XX PCBs
+* Hardware Availability: [iriskeyboards.com](https://www.iriskeyboards.com/en) Currently unavailable - still in testing
+
+Make example for this keyboard (after setting up your build environment):
+
+ make iriskeyboards:default
+
+Flashing example for this keyboard:
+
+ make iriskeyboards: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).