summaryrefslogtreecommitdiff
path: root/keyboards/lefishe/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lefishe/readme.md')
-rw-r--r--keyboards/lefishe/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/lefishe/readme.md b/keyboards/lefishe/readme.md
new file mode 100644
index 0000000000..ae6ab1322e
--- /dev/null
+++ b/keyboards/lefishe/readme.md
@@ -0,0 +1,24 @@
+# lefishe
+
+firmware for the 65xt keyboard designed around the symmetrical blocker 65% layout.
+This pcb cab also be used as a replacement pcb for the revoKmini/kmacmini with some modification to the design
+
+* Keyboard Maintainer: [Lyso1](https://github.com/lyso1)
+* Hardware Supported: LeFishe, atmega32u4
+* Hardware Availability: [/u/TheLysol_27](https://www.reddit.com/user/TheLysol_27)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make lefishe:default
+
+Enter into the bootloader to flash new firmware in 3 ways:
+
+ * **Bootmagic reset**: Hold down the key at (0,0) in the matrix(The F1 key in this case) and plug the the keyboard in.
+ * **Physical reset button**: Briefly press the button on the back and left side of the PCB(exactly under where the "2" key would be located) while the PCB is plugged in.
+ * **Keycode in layout**: Press the key mapped to `RESET` (RALT + E in this case) while the keyboard is plugged in.
+
+Flashing example for this keyboard:
+
+ make lefishe: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).