summaryrefslogtreecommitdiff
path: root/keyboards/matchstickworks/southpad/rev1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/matchstickworks/southpad/rev1/readme.md')
-rw-r--r--keyboards/matchstickworks/southpad/rev1/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/matchstickworks/southpad/rev1/readme.md b/keyboards/matchstickworks/southpad/rev1/readme.md
new file mode 100644
index 0000000000..20b5a58085
--- /dev/null
+++ b/keyboards/matchstickworks/southpad/rev1/readme.md
@@ -0,0 +1,23 @@
+# SouthPad
+
+![Southpad](https://i.imgur.com/Wl71thnh.jpg)
+
+This is a left-handed (or mirrored) numberpad with USB-C connections.
+
+Default layout is such:
+
+![SouthPad Layout](https://i.imgur.com/jc7T2jl.jpg)
+
+* Keyboard Maintainer: [Logan Butler](https://github.com/MatchstickWorks)
+* Hardware Supported: SouthPad v1 PCB
+* Hardware Availability: Either via [my storefront](https://matchstick.works), [my Etsy Store](https://www.etsy.com/shop/MatchstickWorksShop), or by messaging directly
+
+Getting the board into bootloader mode:
+
+In order to flash the firmware to this board, simply press the Reset button on the back of the PCB. You should head a USB disconnect and reconnect sound shortly following.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make matchstickworks/southpad/rev1:default
+
+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).