summaryrefslogtreecommitdiff
path: root/keyboards/sneakbox/ava/readme.md
diff options
context:
space:
mode:
authorSneakboxKB <67670271+SneakboxKB@users.noreply.github.com>2021-08-19 13:58:35 -0500
committerGitHub <noreply@github.com>2021-08-19 11:58:35 -0700
commitb724a0dfd5782f81d52fa006466e607d7ba04c5e (patch)
tree98e167a284ed3de125c76f703705fb4e04d5a9eb /keyboards/sneakbox/ava/readme.md
parenta12f3a3fb87374d1c68417b2f58a22bad687f12c (diff)
downloadqmk_firmware-b724a0dfd5782f81d52fa006466e607d7ba04c5e.tar.gz
qmk_firmware-b724a0dfd5782f81d52fa006466e607d7ba04c5e.zip
[Keyboard] Ava initial commit (#13845)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: SneakboxKB <64090325+mujimanic@users.noreply.github.com>
Diffstat (limited to 'keyboards/sneakbox/ava/readme.md')
-rw-r--r--keyboards/sneakbox/ava/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/sneakbox/ava/readme.md b/keyboards/sneakbox/ava/readme.md
new file mode 100644
index 0000000000..8f65c143fe
--- /dev/null
+++ b/keyboards/sneakbox/ava/readme.md
@@ -0,0 +1,15 @@
+# Sneakbox AVA
+
+![Sneakbox AVA](https://i.imgur.com/lVaAmfSh.jpg)
+
+An Alice-like keyboard featuring a blocked arrow cluster in place of the right shift position. The left sided nav cluster contains four keys. Optional pushbutton rotary encoder socket positioned at the top left key position. Firmware covers both soldered and hotswap versions of the PCB.
+
+* Keyboard Maintainer: [mujimanic](https://github.com/mujimanic)
+* Hardware Supported: AVA-compatible keyboard case. This PCB is different from and is not compatible with conventional Alice keyboard cases or Arisu format cases (right sided arrow cluster + right sided nav cluster).
+* Hardware Availability: [sneakbox.design](https://sneakbox.com/collections/frontpage/products/infopre-order-ava-keyboard-shell)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sneakbox/ava:default
+
+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).