diff options
| author | John Barbero <john@lsrkttn.com> | 2023-11-09 18:52:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-09 09:52:47 -0800 |
| commit | 39d0a14258cbd1dd640405cdbc806dadb01521a8 (patch) | |
| tree | 6fb7338b4873513e5a998cc63e14773d37228f30 /keyboards/snes_macropad/readme.md | |
| parent | daabe2d8c5eab9d9d605f8e079dfae82d2b06a8d (diff) | |
Add SNES Macropad keyboard (#22377)
Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/snes_macropad/readme.md')
| -rw-r--r-- | keyboards/snes_macropad/readme.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/snes_macropad/readme.md b/keyboards/snes_macropad/readme.md new file mode 100644 index 0000000000..9ef5e04149 --- /dev/null +++ b/keyboards/snes_macropad/readme.md @@ -0,0 +1,36 @@ +# snes_macropad + + +*Completed Build* + + +*Completed Build, closer with RGB off* + + +*PCB and FR4 top/bottom plates* + +The SNES Macropad is, as it sounds, a macropad that features a SNES connector. In addition it has a qwiic connector and a 3.5mm jack for 3.3V I2C (not audio), allowing additional expansion. + +This QMK implementation exposes the SNES controller as a part of the keyboard, meaning you can map the controller to do anything a qmk keyboard can. The layout is thus a 4x6 keyboard logically, split with the 3 first rows being on the macro pad and the 3 following being buttons on the snes controller. + +* Keyboard Maintainer: [JBarberU](https://github.com/jbarberu) +* Hardware Supported: SNES Macropad Rev 1, with a Raspberry Pi Pico Lite (AliExpress clone of Raspberry Pico with fewer grounds and all GPIO's exposed on the headers) +* Hardware Availability: The SNES Macro pad can be found [here](https://www.tindie.com/products/jbarberu/snes-macropad/) either as a kit, partially built or fully built. + +Make example for this keyboard (after setting up your build environment): + + make snes_macropad:default + +Flashing example for this keyboard: + + make snes_macropad: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: + +* **Physical bootsel button**: Hold down the bootsel button on the RPi Pico while plugging in the keyboard, or while pressing the reset button +* **Physical reset button**: Quickly double press the reset button +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available |