summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md
diff options
context:
space:
mode:
authorJan Christoph Ebersbach <jceb@e-jc.de>2021-04-14 23:51:08 +0200
committerGitHub <noreply@github.com>2021-04-14 17:51:08 -0400
commitb33e6793de6c5f5124ee88fb3eb62d8f54f74940 (patch)
treeaf55055fc9d3f9d9f3677a9d109e54fe5bc74afe /keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md
parentbcceb701cdfd91ed098407e1d6b7bcd261447621 (diff)
Dactyl manuform 5x6 2 5 keymap (#11353)
* feat(keymap): add DactylManuform w/ 2 extra keys and 5 thumb keys * fix(keymap): add missing readme * chore: add gpl2 license header * chore: add gpl2 license header * docs[dactyl_manuform_5x6_2_5]: reformat readme Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md')
-rw-r--r--keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md b/keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md
new file mode 100644
index 0000000000..d67f940611
--- /dev/null
+++ b/keyboards/handwired/dactyl_manuform/5x6_2_5/readme.md
@@ -0,0 +1,13 @@
+# Dactyl ManuForm Mini
+
+The Dactyl ManuForm Mini is a fork of the [Dactyl ManuForm](https://github.com/tshort/dactyl-keyboard). The Dactyl ManuForm is a fork of the [Dactyl](https://github.com/adereth/dactyl-keyboard) with the thumb cluster from [ManuForm](https://github.com/jeffgran/ManuForm).
+
+This [specific version](https://github.com/jceb/dactyl-manuform-mini-keyboard) of the Dactyl ManuForm Mini adds to additional keys to each side, CTRL and ALT, that are missing in the default configuration of the mini keyboard. In addition, a thumb cluster with 5 keys is enabled.
+
+The keyboard is custom built and handwired. There multiple build guides available.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/dactyl_manuform/5x6_2_5: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).