summaryrefslogtreecommitdiff
path: root/keyboards/handwired/dactyl_minidox/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/dactyl_minidox/readme.md')
-rw-r--r--keyboards/handwired/dactyl_minidox/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/handwired/dactyl_minidox/readme.md b/keyboards/handwired/dactyl_minidox/readme.md
new file mode 100644
index 0000000000..5826403a80
--- /dev/null
+++ b/keyboards/handwired/dactyl_minidox/readme.md
@@ -0,0 +1,27 @@
+# Dactyl Minidox
+
+![DactylMinidox](https://i.imgur.com/PqjgeRfh.jpg)
+
+A 36 key (3x5+3), split bodied keyboard derived from the [Dactyl ManuForm](/keyboards/handwired/dactyl_manuform/).
+
+* Keyboard Maintainer: [Dan Ford](https://github.com/dlford)
+* Hardware Supported: Pro Micro controller, or clone of
+* Hardware Availability: [Build Guide](https://www.dlford.io/keyboard-build-guide-per-key-rgb-leds/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/dactyl_minidox:default
+
+Flashing example for this keyboard:
+
+ make handwired/dactyl_minidox:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) 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 `QK_BOOT` if it is available