summaryrefslogtreecommitdiff
path: root/keyboards/synthandkeys/the_debit_card/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-11-10 20:38:09 +0000
committerQMK Bot <hello@qmk.fm>2022-11-10 20:38:09 +0000
commit35baf1815c93b89a48b4ede32522f6424e614deb (patch)
treec223ca2bf01639b3df0c4288317c244d9cdced46 /keyboards/synthandkeys/the_debit_card/readme.md
parentf6baf916a9ac14cd150f65054573cd1a0e732c5a (diff)
parent6562c5a940fc469413c0cc7e9c6b19a18ca4988e (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/synthandkeys/the_debit_card/readme.md')
-rw-r--r--keyboards/synthandkeys/the_debit_card/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/synthandkeys/the_debit_card/readme.md b/keyboards/synthandkeys/the_debit_card/readme.md
new file mode 100644
index 0000000000..db2fb14cf6
--- /dev/null
+++ b/keyboards/synthandkeys/the_debit_card/readme.md
@@ -0,0 +1,27 @@
+# synthandkeys/the_debit_card
+
+![synthandkeys/the_debit_card](https://i.imgur.com/8dpEv73.jpeg)
+
+The Debit Card is a 10-key programmable mechanical keyboard that could fit in your wallet. The ultra-thin, ultra-portable macropad is powered by the XIAO RP2040 and can support KMK, QMK, or VIAL open-source keyboard firmware.
+
+* Keyboard Maintainer: [Synth and Keys](https://github.com/Synth-and-Keys)
+* Hardware Supported: The Debit Card PCB, Seeed XIAO MCU
+* Hardware Availability: https://etsy.me/3UslJQF, https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html
+
+Make example for this keyboard (after setting up your build environment):
+
+ make synthandkeys/the_debit_card:default
+
+Flashing example for this keyboard:
+
+ make synthandkeys/the_debit_card: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**: Press the button on the Seeed XIAO microcontroller twice.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available