]> git.donarmstrong.com Git - qmk_firmware.git/blob - layouts/community/ergodox/dvorak_emacs/readme.md
Creates a userspace for keymaps (#1559)
[qmk_firmware.git] / layouts / community / ergodox / dvorak_emacs / readme.md
1 # Ergodox Dvorak Layout with emacs binding in mind
2  * Control & Alt key on the thumbs (activated if pressed with another key).
3  * In the same way, "U" and "R" are the shift modifier if pressed with another key.
4  * "I" and "D" set the layer 1 for the auxiliary keys if pressed with another key.
5  * Software layout set to english.
6
7 ## Keymap Layers
8  - L0: dvorak with some customizations (see layout below)
9  - L1: auxiliary keys (includes function keys, numpad...)
10
11
12 ### Keymap 0: Base layer
13 Keys with double values (like U/LSft) correspond to the 'tapped' key and the 'held' key, respectively
14
15 <pre><code>
16
17 ,--------------------------------------------------.           ,--------------------------------------------------.
18 |        |   1  |   2  |   3  |   4  |   5  |  Esc |           |  Esc |   6  |   7  |   8  |   9  |   0  |   =    |
19 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
20 |   ~    |  '   |   ,  |   .  |   P  |   Y  |   [  |           |   ]  |   F  |   G  |   C  |   H  |   L  |   /    |
21 |--------+------+------+------+------+------|   {  |           |   }  |------+------+------+------+------+--------|
22 |  Tab   |   A  |   O  |   E  |U/LSft| I/L1 |------|           |------|  D/L1|R/RSft|   T  |   N  |   S  |   -    |
23 |--------+------+------+------+------+------| LGUI |           | LGUI |------+------+------+------+------+--------|
24 | {/LSft |   ;  |   Q  |   J  |   K  |   X  |      |           |      |   B  |   M  |   W  |   V  |   Z  | }/RSft |
25 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
26   |      |      |      |      | ~L1  |                                       | ~L1  |      |      |   \  |      |
27   `----------------------------------'                                       `----------------------------------'
28                                        ,-------------.       ,-------------.
29                                        | HOME |  END |       | LEFT | RIGHT|
30                                 ,------|------|------|       |------+--------+------.
31                                 | BSPC |  DEL | PGUP |       |  UP  | SPACE  |RETURN|
32                                 |  /   |  /   |------|       |------|   /    |  /   |
33                                 | LCTL | LALT |PGDWN |       | DOWN | LALT   | LCTL |
34                                 `--------------------'       `----------------------'
35
36 </pre></code>
37
38 ### Keymap 1: Aux layer
39
40 <pre><code>
41
42 ,--------------------------------------------------.           ,--------------------------------------------------.
43 |  VolUp |      |      |      |      |      | SLEEP            | PWR  |      |      |      |      |      |        |
44 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
45 |  VolDn |  F1  |  F2  |  F3  |  F4  |      |      |           |      |      |   7  |   8  |   9  |   *  |        |
46 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
47 |        |  F5  |  F6  |  F7  |  F8  | TRANS|------|           |------|TRANS |   4  |   5  |   6  |   +  |        |
48 |--------+------+------+------+------+------|      |           |PSCR  |------+------+------+------+------+--------|
49 |  TRANS |  F9  |  F10 |  F11 |  F12 |      |      |           |      |      |   1  |   2  |   3  |   /  |  TRANS |
50 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
51   |CTRL-S|CTRL-Z|CTRL-X|CTRL-C| TRANS|                                       | TRANS|    . |   0  |   =  |      |
52   `----------------------------------'                                       `----------------------------------'
53                                        ,-------------.       ,-------------.
54                                        | TRANS| TRANS|       | TRANS| TRANS|
55                                 ,------|------|------|       |------+------+------.
56                                 |      |      | TRANS|       | TRANS|      |      |
57                                 |TRANS |TRANS |------|       |------| TRANS| TRANS|
58                                 |      |      | TRANS|       | TRANS|      |      |
59                                 `--------------------'       `--------------------'
60
61 </pre></code>
62
63
64
65 ## Generation of .hex file
66 > In the "qmk_firmware/keyboards/ergodox" directory.
67
68 > Execute "make dvorak_emacs". Then the hex file "ergodox_ez_dvorak_emacs.hex" is in the root directory : "qmk_firmware".
69
70 > Flash with `teensy_loader` binary