summaryrefslogtreecommitdiff
path: root/keyboards/zoo/wampus/readme.md
diff options
context:
space:
mode:
author0z00 <66924917+0z00@users.noreply.github.com>2020-11-22 13:21:51 -0800
committerGitHub <noreply@github.com>2020-11-22 21:21:51 +0000
commit30afa1ccd333a693d7edcda10e618b5c82bc6b98 (patch)
treeb49e0692e6b240702027a63041c52d62afdcacba /keyboards/zoo/wampus/readme.md
parentb8443863c0ae54349ee61411c0c09863a5ad0b8e (diff)
[Keyboard] Add Wampus (#10991)
* Configure new keyboard zoo/wampus * Apply suggestions from code review Update LED pins to defined defaults Co-authored-by: Joel Challis <git@zvecr.com> * Apply suggestions from code review - Remove unused layers from default. - Remove chibios patch comment Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/zoo/wampus/readme.md')
-rw-r--r--keyboards/zoo/wampus/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/zoo/wampus/readme.md b/keyboards/zoo/wampus/readme.md
new file mode 100644
index 0000000000..dc80b8a512
--- /dev/null
+++ b/keyboards/zoo/wampus/readme.md
@@ -0,0 +1,17 @@
+# Wampus
+
+Wampus is an Alice-layout alt-ergo keyboard with daughterboard OLED display support. [More info at zoo.haus](https://zoo.haus)
+
+* Keyboard Maintainer: [zoo](https://github.com/0z00)
+* Hardware Supported: zoo.haus Wampus Case/PCB
+* Hardware Availability: Will be posted at [https://zoo.haus](https://zoo.haus)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make zoo/wampus:default
+
+Flashing example for this keyboard:
+
+ make zoo/wampus: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).