aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/dactyl_manuform/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/dactyl_manuform/readme.md')
-rw-r--r--keyboards/handwired/dactyl_manuform/readme.md51
1 files changed, 37 insertions, 14 deletions
diff --git a/keyboards/handwired/dactyl_manuform/readme.md b/keyboards/handwired/dactyl_manuform/readme.md
index eb76a7150..3f72bd6b2 100644
--- a/keyboards/handwired/dactyl_manuform/readme.md
+++ b/keyboards/handwired/dactyl_manuform/readme.md
@@ -1,32 +1,55 @@
-Dactyl Manuform 5x6
+Dactyl Manuform (4x5, 5x6, 6x6)
======
the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) is a split curved keyboard based on the design of [adereth dactyl](https://github.com/adereth/dactyl-keyboard) and thumb cluster design of the [manuform](https://geekhack.org/index.php?topic=46015.0) keyboard, the hardware is similar to the let's split keyboard. all information needed for making one is in the first link.
![Imgur](https://i.imgur.com/7y0Vbyd.jpg)
## First Time Setup
-
+-----------------
Download or clone the `qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to generate the default .hex using:
+Depending on your Layout chose one of the follwing commands:
+
```
-$ make handwired/dactyl_manuform/5x6:YOUR_KEYMAP_NAME
+$ make handwired/dactyl_manuform/YOUR_LAYOUT:YOUR_KEYMAP_NAME
+```
+
+example:
+```
+$ make handwired/dactyl_manuform/4x5:default
```
If everything worked correctly you will see a file:
```
-dactyl_manuform_5x6_YOUR_KEYMAP_NAME.hex
+dactyl_manuform_YOUR_LAYOUT_YOUR_KEYMAP_NAME.hex
```
For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.
+
## Keymaps
-Currently there are only two keymaps: Qwerty and Dvorak, feel free to make changes and contribute your keymap.
-### Impstyle
+-----------------
+### [Keymaps 4x5](/keyboards/handwired/dactyl_manuform/4x5/keymaps/)
+
+#### Default
+Simple QWERTY layout with 3 Layers.
+#### Dvorak
+
+### [Keymaps 5x6](/keyboards/handwired/dactyl_manuform/5x6/keymaps/)
+#### Default
+Just a copy of the Impstyle keymap. Feel free to adjust it.
+#### Impstyle
+A simple QWERTY keymap with 3 Layers. Both sides are connected via serial and the Left ist the master.
-Required Hardware
+### [Keymaps 6x6](/keyboards/handwired/dactyl_manuform/6x6/keymaps/)
+
+#### Default
+Simple QWERTY layout with 3 Layers.
+
+##Required Hardware
-----------------
Apart from diodes and key switches for the keyboard matrix in each half, you
@@ -39,11 +62,11 @@ Alternatively, you can use any sort of cable and socket that has at least 3
wires. If you want to use I2C to communicate between halves, you will need a
cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
-Optional Hardware
+##Optional Hardware
-----------------
A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
-Wiring
+##Wiring
------
The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
@@ -66,18 +89,18 @@ unnecessary in simple use cases.
You can change your configuration between serial and i2c by modifying your `config.h` file.
-Notes on Software Configuration
+##Notes on Software Configuration
-------------------------------
the keymaps in here are for the 4x5 layout of the keyboard only.
-Flashing
+##Flashing
-------
-From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing.
-Example: `make lets_split/rev2:default:avrdude`
+
+To flash your firmware take a look at: [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)
-Choosing which board to plug the USB cable into (choosing Master)
+##Choosing which board to plug the USB cable into (choosing Master)
--------
Because the two boards are identical, the firmware has logic to differentiate the left and right board.