summaryrefslogtreecommitdiff
path: root/keyboards/mechwild/puckbuddy/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-10 00:24:17 +0000
committerQMK Bot <hello@qmk.fm>2022-08-10 00:24:17 +0000
commit9bbc0cbb3bcd32a5eb56aa2310fc09802256eccb (patch)
treea92e3913bc9a1d9100c8f3448d3c8e76e10d57aa /keyboards/mechwild/puckbuddy/readme.md
parent994a2542af324aef44a515effc9e51999b4fefe8 (diff)
parent7019d0bce890ca97937d62e843adcdc9b9a0d1fd (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/mechwild/puckbuddy/readme.md')
-rw-r--r--keyboards/mechwild/puckbuddy/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/mechwild/puckbuddy/readme.md b/keyboards/mechwild/puckbuddy/readme.md
new file mode 100644
index 0000000000..1663ad4b9c
--- /dev/null
+++ b/keyboards/mechwild/puckbuddy/readme.md
@@ -0,0 +1,27 @@
+# PuckBuddy
+
+![PuckBuddy](https://i.imgur.com/iSVAHJzh.png)
+
+A macropad with a Cirque Glidepoint Trackpad in the middle, powered by the STM32 Blackpill.
+
+* Keyboard Maintainer: [Kyle McCreery](https://github.com/kylemccreery)
+* Hardware Supported: PuckBuddy v1.0
+* Hardware Availability: [PuckBuddy on MechWild](https://mechwild.com/product/puckbuddy/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mechwild/puckbuddy:default
+
+Flashing example for this keyboard:
+
+ make mechwild/puckbuddy:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (assigned to the top left key) and plug in the keyboard while holding it.
+* **Physical reset button**: Press and hold the boot0 button on the blackpill, tap and release the nrst button on the blackpill, then release the boot0 button.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available. By default this is the top right key on layer 1.
+
+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). \ No newline at end of file