aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/iris/readme.md
diff options
context:
space:
mode:
authorGravatar Danny <nooges@users.noreply.github.com>2017-10-19 10:02:00 -0400
committerGravatar Jack Humbert <jack.humb@gmail.com>2017-10-19 04:02:00 -1000
commitb5464cf20aa21bfe3671bd584dfc727878d508e0 (patch)
tree70c454a6ffefee1c950cb1090454935e14864422 /keyboards/iris/readme.md
parent383e508bc56870aa971c4a881ed43dfe2f44f2ce (diff)
downloadqmk_firmware-b5464cf20aa21bfe3671bd584dfc727878d508e0.tar.gz
Add Iris keyboard (#1863)
* Clone Nyquist code to Iris and rename * Set keymap and pins * Work in progress Iris default keymap * Add Iris rev2 * Update Iris files to new build system * Add lewisridden keymap
Diffstat (limited to 'keyboards/iris/readme.md')
-rw-r--r--keyboards/iris/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/iris/readme.md b/keyboards/iris/readme.md
new file mode 100644
index 000000000..1ef27f422
--- /dev/null
+++ b/keyboards/iris/readme.md
@@ -0,0 +1,20 @@
+Iris
+====
+
+A split ergo 4x6 keyboard with 3 or 4 thumb keys made and sold by Keebio. [More info at Keebio](https://keeb.io).
+
+Keyboard Maintainer: [Bakingpy/nooges](https://github.com/nooges)
+Hardware Supported: Pro Micro
+Hardware Availability: [Keebio](https://keeb.io)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make iris/rev2:default
+
+Example of flashing this keyboard:
+
+ make iris/rev2:default:avrdude
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
+A build guide for this keyboard can be found here: [Nyquist Build Guide](https://docs.keeb.io)