summaryrefslogtreecommitdiff
path: root/keyboards/avalanche/readme.md
diff options
context:
space:
mode:
authorWill Winder <wwinder.unh@gmail.com>2022-04-14 14:23:32 -0400
committerGitHub <noreply@github.com>2022-04-14 11:23:32 -0700
commit8de4065b099a99bcffe436a038616b0c31ade7c3 (patch)
treef37c12e155295a04309c1dbce94ff7c6a52f76a7 /keyboards/avalanche/readme.md
parentb9e11253c4d0646176e6455390c917a784ea33c9 (diff)
[Keyboard] Add avalanche (#16407)
* [Keyboard] Add avalanche * PR feedback * Update keyboards/avalanche/v1/config.h * Update keyboards/avalanche/v1/v1.h * Update keyboards/avalanche/v2/config.h * Update keyboards/avalanche/v2/v2.h * Update keyboards/avalanche/v3/config.h * Update keyboards/avalanche/v3/v3.h * Apply suggestions from code review * Remove rules.mk comment and fix other comments. * Shared encoder code, follow conventions in rules.mk files. * Remove config files which do not change defaul behavior.
Diffstat (limited to 'keyboards/avalanche/readme.md')
-rw-r--r--keyboards/avalanche/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/avalanche/readme.md b/keyboards/avalanche/readme.md
new file mode 100644
index 0000000000..d0b07a9c40
--- /dev/null
+++ b/keyboards/avalanche/readme.md
@@ -0,0 +1,27 @@
+# Avalanche
+
+![Avalanche v3.0](https://github.com/vlkv/avalanche/blob/master/images/avalanche_v3-0.jpg)
+
+An open source ergonomic split keyboard with removable keys to support 40% and 60% configurations.
+
+* Keyboard Maintainer: [Vitaly Volkov](https://github.com/vlkv)
+* Hardware Supported: Avalanche PCB v1, v2, v3, Pro Micro 5V/16MHz and compatible.
+* Hardware Availability: [Avalanche](https://github.com/vlkv/avalanche).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make avalanche/v1:default # for v1 PCBs
+ make avalanche/v2:default # for v2 PCBs
+ make avalanche/v3:default # for v3 PCBs
+
+Flashing example for this keyboard:
+
+ make avalanche/v1:default:flash # for v1 PCBs
+ make avalanche/v2:default:flash # for v2 PCBs
+ make avalanche/v3:default:flash # for v3 PCBs
+
+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
+
+Briefly press the button along the inner edge of the PCB next to the microcontroller.