summaryrefslogtreecommitdiff
path: root/layouts/community/ergodox/dvorak_emacs/readme.md
blob: a3fc34afebffac79ab7e97b50eba672cbbe23e4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Ergodox Dvorak Layout with emacs binding in mind
 * Control & Alt key on the thumbs (activated if pressed with another key).
 * In the same way, "U" and "R" are the shift modifier if pressed with another key.
 * "I" and "D" set the layer 1 for the auxiliary keys if pressed with another key.
 * Software layout set to english.

## Keymap Layers
 - L0: dvorak with some customizations (see layout below)
 - L1: auxiliary keys (includes function keys, numpad...)


### Keymap 0: Base layer
Keys with double values (like U/LSft) correspond to the 'tapped' key and the 'held' key, respectively

<pre><code>

,--------------------------------------------------.           ,--------------------------------------------------.
|        |   1  |   2  |   3  |   4  |   5  |  Esc |           |  Esc |   6  |   7  |   8  |   9  |   0  |   =    |
|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
|   ~    |  '   |   ,  |   .  |   P  |   Y  |   [  |           |   ]  |   F  |   G  |   C  |   H  |   L  |   /    |
|--------+------+------+------+------+------|   {  |           |   }  |------+------+------+------+------+--------|
|  Tab   |   A  |   O  |   E  |U/LSft| I/L1 |------|           |------|  D/L1|R/RSft|   T  |   N  |   S  |   -    |
|--------+------+------+------+------+------| LGUI |           | LGUI |------+------+------+------+------+--------|
| {/LSft |   ;  |   Q  |   J  |   K  |   X  |      |           |      |   B  |   M  |   W  |   V  |   Z  | }/RSft |
`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  |      |      |      |      | ~L1  |                                       | ~L1  |      |      |   \  |      |
  `----------------------------------'                                       `----------------------------------'
                                       ,-------------.       ,-------------.
                                       | HOME |  END |       | LEFT | RIGHT|
                                ,------|------|------|       |------+--------+------.
                                | BSPC |  DEL | PGUP |       |  UP  | SPACE  |RETURN|
                                |  /   |  /   |------|       |------|   /    |  /   |
                                | LCTL | LALT |PGDWN |       | DOWN | LALT   | LCTL |
                                `--------------------'       `----------------------'

</pre></code>

### Keymap 1: Aux layer

<pre><code>

,--------------------------------------------------.           ,--------------------------------------------------.
|  VolUp |      |      |      |      |      | SLEEP            | PWR  |      |      |      |      |      |        |
|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
|  VolDn |  F1  |  F2  |  F3  |  F4  |      |      |           |      |      |   7  |   8  |   9  |   *  |        |
|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
|        |  F5  |  F6  |  F7  |  F8  | TRANS|------|           |------|TRANS |   4  |   5  |   6  |   +  |        |
|--------+------+------+------+------+------|      |           |PSCR  |------+------+------+------+------+--------|
|  TRANS |  F9  |  F10 |  F11 |  F12 |      |      |           |      |      |   1  |   2  |   3  |   /  |  TRANS |
`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  |CTRL-S|CTRL-Z|CTRL-X|CTRL-C| TRANS|                                       | TRANS|    . |   0  |   =  |      |
  `----------------------------------'                                       `----------------------------------'
                                       ,-------------.       ,-------------.
                                       | TRANS| TRANS|       | TRANS| TRANS|
                                ,------|------|------|       |------+------+------.
                                |      |      | TRANS|       | TRANS|      |      |
                                |TRANS |TRANS |------|       |------| TRANS| TRANS|
                                |      |      | TRANS|       | TRANS|      |      |
                                `--------------------'       `--------------------'

</pre></code>



## Generation of .hex file
> In the "qmk_firmware/keyboards/ergodox" directory.

> Execute "make dvorak_emacs". Then the hex file "ergodox_ez_dvorak_emacs.hex" is in the root directory : "qmk_firmware".

> Flash with `teensy_loader` binary