aboutsummaryrefslogtreecommitdiff
path: root/keyboards/madjax_macropad/readme.md
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2024-10-28 05:51:14 +0000
committerQMK Bot <[email protected]>2024-10-28 05:51:14 +0000
commit01f6fa7cd6e6215d4e1022c50407ffc5d70e6ce1 (patch)
treef3e2ec1cb8878746a8bebe4a30baf6290a88395e /keyboards/madjax_macropad/readme.md
parent644588baef2c72866ac59767e4d64493948aafed (diff)
parent70055221767ff6b004006d3f349fcfdfcc864180 (diff)
downloadqmk_firmware-01f6fa7cd6e6215d4e1022c50407ffc5d70e6ce1.tar.gz
qmk_firmware-01f6fa7cd6e6215d4e1022c50407ffc5d70e6ce1.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/madjax_macropad/readme.md')
-rw-r--r--keyboards/madjax_macropad/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/madjax_macropad/readme.md b/keyboards/madjax_macropad/readme.md
new file mode 100644
index 0000000000..1abe17ecca
--- /dev/null
+++ b/keyboards/madjax_macropad/readme.md
@@ -0,0 +1,24 @@
+# MadJax Macropad
+
+* Keyboard Maintainer: [Guido Bartolucci](https://github.com/guidoism)
+* Hardware Supported: Seeed Studio XIAO RP2040
+* Hardware Availability: https://github.com/guidoism/madjax_macropad
+
+Make example for this keyboard (after setting up your build environment):
+
+ make madjax_macropad:default
+
+Flashing example for this keyboard:
+
+ make madjax_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:
+
+* **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 `QK_BOOT` if it is available
+