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