]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/ergodox_ez/keymaps/alexjj/readme.md
239e32d399616ff8ffb07bc60135cbe077a947ac
[qmk_firmware.git] / keyboard / ergodox_ez / keymaps / alexjj / readme.md
1 Englishman in New York
2 ===========================
3
4 :microphone: :tea:
5
6 About
7 ------
8
9 After using the massdrop configurator to get the basics, I wanted to add a
10 little extra to my ergodox. Notably the Hyper hotkey, the press and hold,
11 and a way to have my beloved £ :pound: symbol available<sup>[1](#unicode)</sup>. Why not switch to a GB
12 layout? Well the computers I use are US keymap'd and I can't always change
13 that. Plus I've got used to 2/@ and 3/# and moving to the ergodox was hard
14 enough. :sweat_smile:
15
16 I started from the default and edited from there as I needed. It's somewhat
17 similar to a regular layout, particularly R1 and shift/controls. I ended up
18 with a few keys that were blank, so I'm testing out some shortcuts. Alt+F4 for
19 quitting things in Windows, is one example, but I felt it was better placed on 
20 the 1st layer - in case of fat fingers.
21
22 Layout
23 -------
24
25 ![Layout](rl-layout.jpg "Isn't it lovely")
26
27 ### Base Layer
28
29 ```
30 ,--------------------------------------------------.           ,--------------------------------------------------.
31 |   ESC  |  1!  |  2@  |  3#  |  4$  |  5%  |  6^  |           |  7&  |  8*  |  9(  |  0)  |  -_  |  +=  |  BkSp  |
32 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
33 | Tab    |   Q  |   W  |   E  |   R  |   T  |  {   |           |   }  |   Y  |   U  |   I  |   O  |   P  |  |\    |
34 |--------+------+------+------+------+------|  [   |           |   ]  |------+------+------+------+------+--------|
35 | Win    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |  :;  |  '"    |
36 |--------+------+------+------+------+------| Home |           | End  |------+------+------+------+------+--------|
37 | LShift |Z/Alt |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  | Alt  | RShift |
38 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
39   |LCtrl | COPY | PASTE| Left | Right|                                       | Down |  Up  |Hyper |  `~  | RCtrl |
40   `----------------------------------'                                       `----------------------------------'
41                                        ,-------------.       ,-------------.
42   Hyper = Ctrl+Super+Alt+Shift         | ~L3  |  F5  |       |  F2  | ~L2  |
43                                 ,------|------|------|       |------+------+------.
44                                 |      |      | PgUp |       | Ins  |      |      |
45                                 | Enter| BkSp |------|       |------| ~L1  |Space |
46                                 |      |      | PgDn |       | Del  |      |      |
47                                 `--------------------'       `--------------------'
48 ``` 
49
50 ### Symbol Layer
51
52 ```
53 ,--------------------------------------------------.           ,--------------------------------------------------.
54 |        |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |PrintScr|
55 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
56 |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |        |
57 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
58 |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
59 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
60 |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
61 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
62   |      |   £  |      |      |      |                                       |      |    . |   0  |   =  |Alt+F4|
63   `----------------------------------'                                       `----------------------------------'
64              ↑                         ,-------------.       ,-------------.
65           THERE!                       |      |      |       |      |      |
66                                 ,------|------|------|       |------+------+------.
67    CAD = Ctrl + Alt + Delete    |      |      |      |       |      |      |      |
68                                 |      |      |------|       |------|      |      |
69                                 |      |      |      |       | CAD  |      |      |
70                                 `--------------------'       `--------------------'
71 ```
72 ### Media Layer
73
74 Not touched this, not used either.
75
76 ```
77 ,--------------------------------------------------.           ,--------------------------------------------------.
78 | TEENSY |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
79 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
80 |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
81 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
82 |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
83 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
84 |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
85 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
86   |      |      |      | Lclk | Rclk |                                       |VolDn |VolUp | Mute |      |      |
87   `----------------------------------'                                       `----------------------------------'
88                                        ,-------------.       ,-------------.
89                                        |      |      |       |      |      |
90                                 ,------|------|------|       |------+------+------.
91                                 |      |      |      |       |      |      |Brwser|
92                                 |      |      |------|       |------|      |Back  |
93                                 |      |      |      |       |      |      |      |
94                                 `--------------------'       `--------------------'
95 ```
96 ### Unicode Layer
97
98 Used to enter/test unicode input on Windows. All numbers are numpad keys.
99
100 ```
101 ,--------------------------------------------------.           ,--------------------------------------------------.
102 |  Alt   |  1   |   2  |  3   |  4   |   5  |  6   |           |   7  |  8   |   9  |  0   |  +   |  +   |        |
103 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
104 |  Alt   |      |      |   E  |      |      |      |           |      |      |   7  |   8  |  9   |  +   |        |
105 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
106 |  Alt   |   A  |      |   D  |   F  |      |------|           |------|      |   4  |   5  |  6   |  +   |        |
107 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
108 |  Alt   |      |      |   C  |      |   B  |      |           |      |      |   1  |   2  |  3   |  +   |        |
109 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
110   | Alt  |  Alt | Alt  |      |      |                                       |   0  |   0  |  0   |  +   |       |
111   `----------------------------------'                                       `----------------------------------'
112                                        ,-------------.       ,-------------.
113      WINDOWS ONLY SETUP!!              | ~L3  |      |       |      |      |
114                                 ,------|------|------|       |------+------+------.
115                                 |      |      |      |       |      |      |      |
116                                 |  Alt |  Alt |------|       |------|  Alt | Alt  |
117                                 |      |      |      |       |      |      |      |
118                                 `--------------------'       `--------------------'
119 ```
120
121
122 Usage
123 ------
124
125 ~L1 / L2 / L3 will momentarily switch to a layer if held and another key is pressed.
126 If pressed and released will remain on layer until pressed again.
127
128 ### Unicode
129
130 This layout is for Windows only. To enter a character Press and Hold Alt, type + and hex code then release Alt.
131
132 Changelog
133 -----------
134
135 ### [0.2.1] - 2016-04-05
136
137 * Changed £ to alt code in Windows. Windows sucks at unicode.
138
139 ### [0.2.0] - 2016-03-27
140
141 * Added unicode layer
142 * Moved Copy/Paste to left hand side
143 * Switched Enter and Space (again)
144 * Added L3 (unicode layer) toggle
145 * Removed Press and Hold for Alt on right hand size (/)
146 * Swapped Volume Up/Down to match arrows
147 * Tried fixing £ macro
148 * Removed * in the matrix function things (upstream change)
149
150 ### [0.1.1] - 2016-03-23
151
152 * Changed £ input to a macro
153
154
155 ### [0.1.0] - 2016-03-22
156
157 After actually using the keyboard, I've made some changes:
158
159 * Swapped Enter and Space
160 * Moved backspace to thumb keys (top right still remains)
161 * Added Ctrl+Alt+Delete
162 * Added Teensy Reset on 2nd layer
163 * Switched Up and Down
164 * Changed copy/paste to be Ctrl+c and Ctrl+v as KC_COPY/PASTE didn't work (in Windows)
165 * Moved ~L2 to replace +L1 after learning how the function works (notes above)
166 * Hopefully fixed GBP symbol (unicode enabled in MakeFile)
167
168 ### [0.0.1] - 2016-03-21
169
170 First version
171
172
173 Issues
174 -------
175
176 Space for feedback and notes for future improvements
177
178 ----
179 <sup><a name="unicode">1</a></sup>: For Windows only, and you have to edit the [registry](https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_code_input).