summaryrefslogtreecommitdiff
path: root/keyboards/matchstickworks/southpad/readme.md
diff options
context:
space:
mode:
authorLogan Butler <8854426+MatchstickWorks@users.noreply.github.com>2021-08-13 11:29:59 -0700
committerGitHub <noreply@github.com>2021-08-13 11:29:59 -0700
commitf00e56eb0b4e8ab220d52a30f89f3a9213d431fa (patch)
treef891e3bc44f448d410648f85fdcba710d7cd2e95 /keyboards/matchstickworks/southpad/readme.md
parent8392729d7410246ab3228d47df272da5b0c72c99 (diff)
[Keyboard] Add Southpad Keyboard (#13964)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/matchstickworks/southpad/readme.md')
-rw-r--r--keyboards/matchstickworks/southpad/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/matchstickworks/southpad/readme.md b/keyboards/matchstickworks/southpad/readme.md
new file mode 100644
index 0000000000..8c8007c2e7
--- /dev/null
+++ b/keyboards/matchstickworks/southpad/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 PCB
+* Hardware Availability: Either via [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: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).