]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/ergodox_ez/keymaps/alexjj/readme.md
Revised to version 0.1.0
[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. 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 |  `~  | Hyper| Left | Right|                                       | Down |  Up  | COPY | PASTE| RCtrl |
40    `----------------------------------'                                       `----------------------------------'
41                                         ,-------------.       ,-------------.
42    Hyper = Ctrl+Super+Alt+Shift         | Alt  |  F5  |       |  F2  | ~L2  |
43                                  ,------|------|------|       |------+------+------.
44                                  |      |      | PgUp |       | Ins  |      |      |
45                                  | Space| BkSp |------|       |------| ~L1  |Enter |
46                                  |      |      | PgDn |       | Del  |      |      |
47                                  `--------------------'       `--------------------'
48
49 ``` 
50
51 ### Symbol Layer
52
53 ```
54  ,--------------------------------------------------.           ,--------------------------------------------------.
55  |        |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |PrintScr|
56  |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
57  |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |        |
58  |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
59  |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
60  |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
61  |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
62  `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
63    |      |   £  |      |      |      |                                       |      |    . |   0  |   =  |Alt+F4|
64    `----------------------------------'                                       `----------------------------------'
65               ↑                         ,-------------.       ,-------------.
66            THERE!                       |      |      |       |      |      |
67                                  ,------|------|------|       |------+------+------.
68     CAD = Ctrl + Alt + Delete    |      |      |      |       |      |      |      |
69                                  |      |      |------|       |------|      |      |
70                                  |      |      |      |       | CAD  |      |      |
71                                  `--------------------'       `--------------------'
72 ```
73 ### Media Layer
74
75 Not touched this, not used either.
76
77 ```
78  ,--------------------------------------------------.           ,--------------------------------------------------.
79  | TEENSY |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
80  |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
81  |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
82  |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
83  |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
84  |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
85  |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
86  `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
87    |      |      |      | Lclk | Rclk |                                       |VolUp |VolDn | Mute |      |      |
88    `----------------------------------'                                       `----------------------------------'
89                                         ,-------------.       ,-------------.
90                                         |      |      |       |      |      |
91                                  ,------|------|------|       |------+------+------.
92                                  |      |      |      |       |      |      |Brwser|
93                                  |      |      |------|       |------|      |Back  |
94                                  |      |      |      |       |      |      |      |
95                                  `--------------------'       `--------------------'
96 ```
97
98 Usage
99 ------
100
101 ~L1 / L2 will momentarily switch to a layer if held and another key is pressed.
102 If pressed and released will remain on layer until pressed again.
103
104
105 Changelog
106 -----------
107
108 ### [0.1.0] - 2016-03-21
109
110 After actually using the keyboard, I've made some changes:
111
112 * Swapped Enter and Space
113 * Moved backspace to thumb keys (top right still remains)
114 * Added Ctrl+Alt+Delete
115 * Added Teensy Reset on 2nd layer
116 * Switched Up and Down
117 * Changed copy/paste to be Ctrl+c and Ctrl+v as KC_COPY/PASTE didn't work (in Windows)
118 * Moved ~L2 to replace +L1 after learning how the function works (notes above)
119 * Hopefully fixed GBP symbol (unicode enabled in MakeFile)
120
121 ### [0.0.1] - 2016-03-21
122
123 First version
124
125
126 Issues
127 -------
128
129 Space for feedback and notes for future improvements
130
131