summaryrefslogtreecommitdiffstats
path: root/keyboards/kapcave/arya/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kapcave/arya/readme.md')
-rw-r--r--keyboards/kapcave/arya/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/kapcave/arya/readme.md b/keyboards/kapcave/arya/readme.md
new file mode 100644
index 0000000000..12fe9684a5
--- /dev/null
+++ b/keyboards/kapcave/arya/readme.md
@@ -0,0 +1,23 @@
+# KapCave Arya
+
+Firmware for the KapCave Arya Keyboard
+
+* Keyboard Maintainer: [KapCave](https://github.com/nachie)
+* Hardware Supported: Arya PCB
+* Hardware Availability: [KapCave](https://kapcave.com/products/arya-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kapcave/arya:default
+
+Or to make and flash:
+
+ make kapcave/arya: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
+
+* **Bootmagic reset**: Hold down Right Space key and plug in the keyboard
+* **Physical reset button**: Briefly press the button labeled "SW_RST1" on the back of the PCB