aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/dmqdesign/spin/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/dmqdesign/spin/readme.md')
-rw-r--r--keyboards/dmqdesign/spin/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/dmqdesign/spin/readme.md b/keyboards/dmqdesign/spin/readme.md
new file mode 100644
index 000000000..8f856a81d
--- /dev/null
+++ b/keyboards/dmqdesign/spin/readme.md
@@ -0,0 +1,17 @@
+# SPIN
+
+![SPIN](https://i.imgur.com/5oYg1WD.jpg)
+
+The SPIN Macro Pad is a USB-C, hotswappable Macro Pad with 3 encoders designed by Nick from DMQ Design.
+
+* Keyboard Maintainer: [Nicholas Junker](https://github.com/Quarren42)
+* Hardware Supported: SPIN Macro Pad PCB/kit
+* Hardware Availability: The macro pad is available at [DMQdesign.com](www.dmqdesign.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make dmqdesign/spin:default
+
+I have two example keymaps available, both the default and the encoderlayers keymap which demonstrates using different encoder functions based on the layer chosen.
+
+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).