logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (5116B)

    

  1. # Dactyl ManuForm
  3. ![Imgur](https://i.imgur.com/7y0Vbydh.jpg)  
  4. *Pair of Dactyl Manuform 4x6*
  6. Forked from the [Dactyl](/keyboards/handwired/dactyl), the *Dactyl ManuForm* is a parameterized, handwired, split bodied, tented, concave key-well design that incorporates the thumb cluster from the [ManuForm](https://geekhack.org/index.php?topic=46015.0).
  8. * Keyboard Maintainer: [Tom Short](https://github.com/tshort)
  9. * Hardware Supported: Pro Micro, or clone of
  10. * Hardware Availability: [Github](https://github.com/tshort/dactyl-keyboard)
  12. ## Variants
  14. *Dactyl ManuForm's* are built in variations that cater for different row and column counts, and thumb clusters.  
  16. As standard: 
  17. - The finger keywell bottom row has 2 keys, 1 each in ring and middle columns
  18.     - Exception to this rule is the `5x7` variant - that has two additional keys, per half, in this row
  19. - The thumb cluster has 6 keys, arranged in a staggered 2 columns by 3 rows 
  21. Variants are denoted as `RowCount`*x*`ColumnCount`*(_`Alteration`)*
  23. ### Row
  24. | Count | Description |
  25. | :---: | :---: |
  26. | 4 | Three rows, typically for alphabet and some puncuation characters, with 2 key (finger keywell) bottom row |
  27. | 5 | As *4 row* with number row above |
  28. | 6 | As *5 row* with function row above |
  30. ### Column
  31. | Count | Description |
  32. | :---: | :---: |
  33. | 5 | A column for each finger with additional column for first finger |  
  34. | 6 | As *5 column* with additional pinky finger column |
  35. | 7 | As *6 column* with either an additional first finger column (`5x7`) or additional pinky column (`6x7`) |  
  37. ### Alteration
  38. | Code | Description |
  39. | :---: | :---: |
  40. | 5 | Thumb cluster replaced with five key thumb cluster of [Dactyl Manuform Mini](https://github.com/l4u/dactyl-manuform-mini-keyboard) | 
  41. | 2_5 | Same as code *5* with two additional keys added to finger key-well bottom row |
  43. ## Case Files Generator
  45. [Dactyl Generator](https://ryanis.cool/dactyl), created by [rianadon](https://github.com/rianadon), is a web based file generator that negates having to compose case files using programming languages, which was the matter when using the original *Dactyl* and *Dactyl ManuForm* GitHub repos, by instead compiling case files based on options and parameters configured in a web front end.
  47. ## Compile
  49. Make example for this keyboard (after setting up your build environment) in the 5x6 variant:
  51.     make handwired/dactyl_manuform/5x6:default
  53. Flashing example for this keyboard:
  55.     make handwired/dactyl_manuform/5x6:default:flash
  57. 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).
  59. ## Keymaps
  61. ### Default
  63. The default functional layout, based on QWERTY, and every variant has this keymap; used as a starting point/template for custom keymaps and for debugging purposes when soldering key matrix to controller.
  65. ### VIA
  66. Similar to *Default* but adds support for the [VIA](https://usevia.app/) keymap configurator. Layer count set to 4 to comply with VIA defaults, and remaps keys to accommodate this constraint, if applicable.
  68. Variants with VIA support:
  69. - 4x6
  70. - 5x6_5
  71. - 5x7
  73. ### Miryoku
  75. For more information on this layout schematic, please see the [Miryoku Reference Manual](https://github.com/manna-harbour/miryoku/tree/master/docs/reference).  
  76. For QMK specifics, please see [Miryoku QMK](https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/users/manna-harbour_miryoku).  
  78. Variants with *Miryoku* support:
  79. - 4x5
  80. - 4x5_5
  81. - 4x6
  82. - 4x6_5
  83. - 5x6
  85. ## Non-Pro Micro Controller Compilation
  87. If building a Dactyl Manuform with controllers that aren't a pro micro, the Converter feature of QMK will allow compilation of firmware for the intended variant and supported controller without having to create a new QMK keyboard/keymap.  
  88. Please see [Converters](https://docs.qmk.fm/#/feature_converters?id=supported-converters) documentation for list of controllers that are supported converting from `pro_micro` and how to implement conversion.
  90. ## Flashing
  92. To flash your board with generated firmware file, please see [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)
  94. ## Handedness configurations
  96. See [Handedness](https://docs.qmk.fm/#/config_options?id=setting-handedness) documentation for more information on configuring handedness/master half.
  98. ## VIA Configuration 
  100. Variants with a `via` keymap are VIA capable. 
  101. Compile firmware, for [enabled variant](#via), with it's `via` keymap and flash board with this firmware file.
  102. ```
  103. qmk compile -kb handwired/dactyl_manuform/4x6 -km via
  104. ```
  106. ## Bootloader
  108. Enter the bootloader in 3 ways:
  110. * **Bootmagic reset**: If enabled, hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
  111. * **Physical reset button**: Briefly press the button on the back of the PCB or controller - some may have pads you must short instead
  112. * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available