aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/maartenwut/quackfire/readme.md
diff options
context:
space:
mode:
authorMaarten Dekkers <maartenwut@gmail.com>2020-08-08 19:49:21 +0200
committerGitHub <noreply@github.com>2020-08-08 10:49:21 -0700
commita536e1bd8f29f82eb5cd4a7db6a4874bd469a076 (patch)
tree499605e31dc94ac9f5269481cf0cf6ad70f54ce9 /keyboards/maartenwut/quackfire/readme.md
parent78fef0a46aa29e3fd97ba1723f652c5cd79ad2b3 (diff)
downloadfirmware-a536e1bd8f29f82eb5cd4a7db6a4874bd469a076.tar.gz
firmware-a536e1bd8f29f82eb5cd4a7db6a4874bd469a076.tar.bz2
firmware-a536e1bd8f29f82eb5cd4a7db6a4874bd469a076.zip
[Keyboard] Add Quackfire controller (#9958)
* Add Quackfire controller * Comply with PR checklist * Update VIA keymap * Update keyboards/maartenwut/quackfire/readme.md
Diffstat (limited to 'keyboards/maartenwut/quackfire/readme.md')
-rw-r--r--keyboards/maartenwut/quackfire/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/maartenwut/quackfire/readme.md b/keyboards/maartenwut/quackfire/readme.md
new file mode 100644
index 000000000..44f1d7fea
--- /dev/null
+++ b/keyboards/maartenwut/quackfire/readme.md
@@ -0,0 +1,19 @@
+# Quackfire
+
+A drop-in replacement controller for the CM Quickfire Rapid. Not for the Quickfire Rapid-I!
+
+* Keyboard Maintainer: [Maartenwut](https://github.com/Maartenwut)
+* Hardware Supported: Quackfire controller
+* Hardware Availability: [Open source on GitHub](https://github.com/Maartenwut/quackfire-controller)
+
+## Flashing
+
+To get to the bootloader, hold Fn while plugging in the keyboard. You can also press Fn + Esc on the default layout.
+
+---
+
+Make example for this keyboard (after setting up your build environment):
+
+ make maartenwut/quackfire: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).