summaryrefslogtreecommitdiff
path: root/keyboards/adalyn/readme.md
diff options
context:
space:
mode:
authorTJ <tom.campie@gmail.com>2022-01-06 21:07:06 -0600
committerGitHub <noreply@github.com>2022-01-06 19:07:06 -0800
commit7ed34bb59fc61114cd2c1e329f40a8a2598d9357 (patch)
tree6d28d98f4879123afb07fbe118590c5e56a40aff /keyboards/adalyn/readme.md
parentdb8cf0b872a1350f11d2de931f7b375feaec69c2 (diff)
[Keyboard] Adalyn keyboard (#14184)
* first Adalyn commit * fixed json and removed via * fixed GPL headers and rules.mk * fix extra space after gpl add vial keymap * Removed VIAL and revised rules.mk * updating per request and completing readme
Diffstat (limited to 'keyboards/adalyn/readme.md')
-rw-r--r--keyboards/adalyn/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/adalyn/readme.md b/keyboards/adalyn/readme.md
new file mode 100644
index 0000000000..ee24bead61
--- /dev/null
+++ b/keyboards/adalyn/readme.md
@@ -0,0 +1,19 @@
+# Adalyn
+
+![Adalyn](https://i.imgur.com/3mGQlh2.jpg)
+
+*A cool QAZ-Alice hybrid designed by [Marv](https://github.com/MarvFPV/Adalyn) with a PCB by [tominabox1](https://github.com/tominabox1)*
+* Keyboard Maintainer: [tominabox1](https://github.com/tominabox1)
+* Hardware Supported: Adalyn PCB, atmega32u4
+* Hardware Availability: Open source on @tominabox1 GitHub
+
+Make example for this keyboard (after setting up your build environment):
+ make adalyn:default
+Flashing example for this keyboard:
+ make adalyn: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 (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