summaryrefslogtreecommitdiffstats
path: root/keyboards/aya/readme.md
diff options
context:
space:
mode:
authorDan Nixon <dan@dan-nixon.com>2021-09-15 07:56:12 +0100
committerGitHub <noreply@github.com>2021-09-14 23:56:12 -0700
commita2d43ca024d8e840c882cc72e80e9eb6b70384f1 (patch)
treebc0987aa76cad2528d5645d1a4ebbff43cd0bfa8 /keyboards/aya/readme.md
parentc2f2f9bfd3f5c927496a80e7074fa7c54a2c1619 (diff)
[Keyboard] Add Aya keyboard (#14378)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/aya/readme.md')
-rw-r--r--keyboards/aya/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/aya/readme.md b/keyboards/aya/readme.md
new file mode 100644
index 0000000000..4e8e4228a0
--- /dev/null
+++ b/keyboards/aya/readme.md
@@ -0,0 +1,20 @@
+# Aya
+
+![Aya](https://raw.githubusercontent.com/DanNixon/aya/main/docs/both_sides.jpg)
+
+A column staggered, symmetrical split keyboard.
+
+* Keyboard Maintainer: [Dan Nixon](https://github.com/dannixon)
+* Hardware Supported: Aya PCB, Pro Micro
+* Hardware Availability: CAD files [here](https://github.com/DanNixon/aya)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make aya:default
+
+Enter the bootloader in 2 ways:
+
+* **Command**: Hold down both shift keys and press B
+* **Physical reset button**: Briefly short the pads on the read of the PCB (directly behind the Pro Micro)
+
+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).