summaryrefslogtreecommitdiff
path: root/keyboards/kingly_keys/ave/readme.md
diff options
context:
space:
mode:
authorGarret G <45295190+The-Royal@users.noreply.github.com>2020-11-09 23:03:12 -0600
committerGitHub <noreply@github.com>2020-11-09 21:03:12 -0800
commit53f11668a3399ff1bdf82902a7717832831219bf (patch)
treebbe2e161ff7203ad583bffb380f3a2b82b331256 /keyboards/kingly_keys/ave/readme.md
parent2ef68a84b68875b189bee58d1fb554ebb62f8e58 (diff)
[Keyboard] kingly_keys/ave (#10042)
* Add configurator support for "The Ave." keyboard * Update readme.md * update misc nomenclature * add punctuation * fix miss-placed "0" * update README.md * del. duplicate "F11" in visual layout information * Split PCB configurations into subfolders * update layer template to new matrix title * rm primary <keyboard>.c / <keyboard>.h files * add new end line to both .h subfolder fiels * Apply suggestions from code review * tested update to RGB code * update rgb code * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Update rules.mk * Update rules.mk * Delete rules.mk * Delete rules.mk * Update rules.mk * Update config.h * Update config.h * Update keymap.c * Update ortho.c * Update ortho.h * Update config.h * Update keymap.c * Update staggered.c * Update staggered.h * Apply suggestions from code review * Update config.h * Update keymap.c * move and duplicate rules.mk file * Update keyboards/kingly_keys/ave/readme.md * Update config.h * Update keyboards/kingly_keys/ave/config.h
Diffstat (limited to 'keyboards/kingly_keys/ave/readme.md')
-rw-r--r--keyboards/kingly_keys/ave/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kingly_keys/ave/readme.md b/keyboards/kingly_keys/ave/readme.md
new file mode 100644
index 0000000000..080edf4966
--- /dev/null
+++ b/keyboards/kingly_keys/ave/readme.md
@@ -0,0 +1,21 @@
+# The Ave. (Avenue)
+
+![ave-img-1](https://i.imgur.com/l5ah6uMl.png)
+
+A Compact Battlestation.
+
+- Keyboard Maintainer: [The-Royal](https://github.com/the-royal)
+- Hardware Supported: Rev10.0 Avenue PCBs *(Ortholinear & Staggered)*
+- Hardware Availability: Through group-buy or self procurement via open-source files.
+
+Make examples for this keyboard (after setting up your build environment):
+
+**Ortholinear:**
+
+ make kingly_keys/ave/ortho:default
+
+**Staggered:**
+
+ make kingly_keys/ave/staggered: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).