summaryrefslogtreecommitdiff
path: root/keyboards/dumbpad/v3x/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/dumbpad/v3x/readme.md')
-rw-r--r--keyboards/dumbpad/v3x/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/dumbpad/v3x/readme.md b/keyboards/dumbpad/v3x/readme.md
new file mode 100644
index 0000000000..96b0537946
--- /dev/null
+++ b/keyboards/dumbpad/v3x/readme.md
@@ -0,0 +1,27 @@
+# dumbpad v3.x - rgb & hotswap
+
+![dumbpad](https://i.imgur.com/ND03FiFl.png)
+
+A 4x4 numpad/macropad with a rotary encoder to the left of the bottom row of keys.
+
+- Keyboard Maintainer: [imchipwood](https://github.com/imchipwood) // [deveth0](https://github.com/deveth0)
+- Hardware repository: [dumbpad on github](https://github.com/imchipwood/dumbpad)
+- PCB Revisions Supported: v3.1
+
+Make example for this keyboard (after setting up your build environment):
+
+ make dumbpad/v3x:default
+
+Flashing example for this keyboard:
+
+ make dumbpad/v3x:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+- **Bootmagic reset**: Hold down the encoder and plug in the keyboard
+- **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+- **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+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).