summaryrefslogtreecommitdiff
path: root/keyboards/atreyu/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/atreyu/readme.md')
-rw-r--r--keyboards/atreyu/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/atreyu/readme.md b/keyboards/atreyu/readme.md
new file mode 100644
index 0000000000..877e8788d2
--- /dev/null
+++ b/keyboards/atreyu/readme.md
@@ -0,0 +1,29 @@
+# atreyu
+
+![atreyu](https://i.imgur.com/NP0cux1h.jpg)
+
+An unsplit, modified version of a Lily58 having a baby with a Sofle keyboard
+
+* Keyboard Maintainer: [Jesus Climent](https://github.com/Jesus Climent)
+* Hardware Supported: AtreyuKeyboard PCB, ProMicro
+* Hardware Availability: [PCB and case data](https://github.com/climent/atreyu)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make atreyu:default
+
+Flashing example for this keyboard:
+
+ make atreyu:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+## More information
+
+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).