summaryrefslogtreecommitdiff
path: root/keyboards/irene/readme.md
diff options
context:
space:
mode:
authorRamon Imbao <ramonimbao@gmail.com>2021-08-14 12:54:38 +0800
committerGitHub <noreply@github.com>2021-08-13 21:54:38 -0700
commit088d6abf5455ab8ea3e7f3071cd7ce674f12fce8 (patch)
treeb196476a0b21aa75cd8b58a0fcd4b02036487a9d /keyboards/irene/readme.md
parent2881517097b3b2e74a4c5e8d39306c2218974217 (diff)
[Keyboard] Add Irene Keyboard (#13991)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/irene/readme.md')
-rw-r--r--keyboards/irene/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/irene/readme.md b/keyboards/irene/readme.md
new file mode 100644
index 0000000000..56dfd4bfbd
--- /dev/null
+++ b/keyboards/irene/readme.md
@@ -0,0 +1,20 @@
+# Irene
+
+![Irene](https://i.imgur.com/p4bWtKDl.jpeg)
+
+The Irene is a polycarbonate top-mount keyboard featuring the Alice layout inspired by TGR's Police and Jaxxstatic's Rukia. The name came from a Kpop idol Irene from Red Velvet.
+
+* Keyboard Maintainer: [Andrei Collado](https://github.com/colladoandrei)
+* Hardware Supported: ATmega32u4
+
+Make example for this keyboard (after setting up your build environment):
+
+ make irene:default
+
+To get to the bootloader, simply press the reset button located on the back of the PCB. You can then flash new firmware onto it.
+
+Flashing example for this keyboard:
+
+ make irene: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).