summaryrefslogtreecommitdiff
path: root/keyboards/dmqdesign/spin/readme.md
diff options
context:
space:
mode:
authorNicholas Junker <nicholas.junker125@gmail.com>2020-04-20 22:55:17 -0400
committerGitHub <noreply@github.com>2020-04-20 19:55:17 -0700
commit92a50a386af4bfe8ce69766719d95df1126917ca (patch)
tree8f14a39cbb6ea0af2490999839a5b1ec1e041afc /keyboards/dmqdesign/spin/readme.md
parent357c6009be059b196f15b4c77306ac88a8d13d87 (diff)
downloadqmk_firmware-92a50a386af4bfe8ce69766719d95df1126917ca.tar.gz
qmk_firmware-92a50a386af4bfe8ce69766719d95df1126917ca.zip
[Keyboard] DMQ Design SPIN (#8820)
* added SPIN keyboard and respective keymaps * Update keyboards/dmqdesign/spin/keymaps/default/keymap.c * Update keyboards/dmqdesign/spin/keymaps/encoderLayers/keymap.c * Update keyboards/dmqdesign/spin/rules.mk * Update keyboards/dmqdesign/spin/spin.c * Update keyboards/dmqdesign/spin/spin.h * Update keyboards/dmqdesign/spin/keymaps/encoderLayers/keymap.c * Update keyboards/dmqdesign/spin/readme.md * Update keyboards/dmqdesign/spin/readme.md * Update keyboards/dmqdesign/spin/spin.h * Update keyboards/dmqdesign/spin/rules.mk * Update keyboards/dmqdesign/spin/config.h * Update keyboards/dmqdesign/spin/keymaps/encoderLayers/keymap.c * Update keyboards/dmqdesign/spin/keymaps/encoderLayers/keymap.c * changed keymap to all lowercase, removed LED typecasts * made encoderLayers all lowercase * fixed the duplicate folder after changing name (hopefully) * fixed the info.json, followed the keyboard support doc * Update keyboards/dmqdesign/spin/info.json * Update keyboards/dmqdesign/spin/info.json * Update keyboards/dmqdesign/spin/info.json * Update keyboards/dmqdesign/spin/info.json
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 0000000000..8f856a81d9
--- /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).