diff options
| author | Kyle McCreery <mccreery.kyle@gmail.com> | 2022-08-23 13:50:19 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-23 10:50:19 -0700 |
| commit | 78393966147bd7e862fd42ca0f0c3236ac45f10f (patch) | |
| tree | d7c96d3dcbf8a6323e11665c923eaeee974a4e8c /keyboards/mechwild/clunker/readme.md | |
| parent | ee416048d974e6a40c0eef48126c19a6fc6f53f4 (diff) | |
[Keyboard] Add Clunker (#18141)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/mechwild/clunker/readme.md')
| -rw-r--r-- | keyboards/mechwild/clunker/readme.md | 25 |
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 + + + +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 |