summaryrefslogtreecommitdiff
path: root/keyboards/keebio/iris_ce/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keebio/iris_ce/readme.md')
-rw-r--r--keyboards/keebio/iris_ce/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/keebio/iris_ce/readme.md b/keyboards/keebio/iris_ce/readme.md
new file mode 100644
index 0000000000..7b3ea32dd1
--- /dev/null
+++ b/keyboards/keebio/iris_ce/readme.md
@@ -0,0 +1,25 @@
+# Iris CE (Compact Edition)
+
+A split ergo 4x6 keyboard with 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: Iris CE PCBs w/RP2040 microcontroller
+* Hardware Availability: [Keebio](https://keeb.io)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keebio/iris_ce/rev1:default
+
+Example of flashing this keyboard:
+
+ make keebio/iris_ce/rev1: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at the top left and plug in the keyboard
+* **Physical reset button**: Press and hold the button on the back of the PCB for at least 1 second and let go
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available