summaryrefslogtreecommitdiff
path: root/keyboards/handwired/lemonpad/readme.md
diff options
context:
space:
mode:
authorDari <41168529+dari-studios@users.noreply.github.com>2022-02-26 20:18:51 -0500
committerGitHub <noreply@github.com>2022-02-26 17:18:51 -0800
commitd94b5d0b8219dfce42aad5798d3bb1d6cf7fec19 (patch)
tree8800e17ddfb81e2c9ac027b71af64e8c8df5a127 /keyboards/handwired/lemonpad/readme.md
parent3057e5f8ca523427644ca1e8745bc0b5492a6d67 (diff)
downloadqmk_firmware-d94b5d0b8219dfce42aad5798d3bb1d6cf7fec19.tar.gz
qmk_firmware-d94b5d0b8219dfce42aad5798d3bb1d6cf7fec19.zip
[Handwired] Support for Adafruit lemon keypad (#16395)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: zvecr <git@zvecr.com>
Diffstat (limited to 'keyboards/handwired/lemonpad/readme.md')
-rw-r--r--keyboards/handwired/lemonpad/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/handwired/lemonpad/readme.md b/keyboards/handwired/lemonpad/readme.md
new file mode 100644
index 0000000000..4c1c2082e9
--- /dev/null
+++ b/keyboards/handwired/lemonpad/readme.md
@@ -0,0 +1,27 @@
+# lemonpad
+
+![lemonpad](https://i.imgur.com/hAp2Nich.jpeg)
+
+This is a QMK and VIA implementation for an atmega32u4 based adaptation of the Adafruit Lemon Keypad. By default it uses a Pro Micro, if you would like to use a different microcontroller please make sure you have the correct bootloader set.
+
+* Keyboard Maintainer: [dari-studios](https://github.com/dari-studios)
+* Hardware Supported: atmega32u4 based boards with the Caterina bootloader
+* Hardware Availability: https://learn.adafruit.com/qtpy-lemon-mechanical-keypad-macropad
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/lemonpad:default
+
+Flashing example for this keyboard:
+
+ make handwired/lemonpad:default:flash
+
+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).
+
+## 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 back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available