summaryrefslogtreecommitdiff
path: root/keyboards/mechwild/clunker/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-23 17:51:17 +0000
committerQMK Bot <hello@qmk.fm>2022-08-23 17:51:17 +0000
commitdd0277beab7a64af14db1ddf3c2358c95e8d6bf6 (patch)
treefb5b1256355eadedda2d971862fecce2834cd75f /keyboards/mechwild/clunker/readme.md
parentf03f89ccb578c7c96f8d23aa85245ac913cc287e (diff)
parent78393966147bd7e862fd42ca0f0c3236ac45f10f (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/mechwild/clunker/readme.md')
-rw-r--r--keyboards/mechwild/clunker/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/mechwild/clunker/readme.md b/keyboards/mechwild/clunker/readme.md
new file mode 100644
index 0000000000..b567e74190
--- /dev/null
+++ b/keyboards/mechwild/clunker/readme.md
@@ -0,0 +1,25 @@
+# Clunker
+
+![clunker](https://i.imgur.com/6X5ijDoh.jpg)
+
+The Clunker is a 40% DIY kit with a knob and solenoid.
+
+* Keyboard Maintainer: [Kyle McCreery](https://github.com/kylemccreery)
+* Hardware Supported: Clunker v1.3
+* Hardware Availability: [Clunker on MechWild](https://mechwild.com/product/clunker/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mechwild/clunker:default
+
+Flashing example for this keyboard:
+
+ make mechwild/clunker:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the top of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file