summaryrefslogtreecommitdiff
path: root/keyboards/waterfowl/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/waterfowl/readme.md')
-rw-r--r--keyboards/waterfowl/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/waterfowl/readme.md b/keyboards/waterfowl/readme.md
new file mode 100644
index 0000000000..9b504ca769
--- /dev/null
+++ b/keyboards/waterfowl/readme.md
@@ -0,0 +1,21 @@
+# Waterfowl
+
+The Waterfowl is a 36-key split keyboard inspired by the Kyria and Arch-36.
+
+* Keyboard Maintainer: [CyanDuck](https://github.com/JW2586)
+* Hardware Supported: Pro Micro 5V/16MHz and compatible.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make waterfowl:default
+
+Example of flashing this keyboard:
+
+ make waterfowl:default:flash
+
+Enter the bootloader by:
+- Press the key mapped to reset (bottom left key in FUNC layer/layer 3)
+- Press the reset button on the PCB
+- Connect GND and RST pins on 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).