aboutsummaryrefslogtreecommitdiff
path: root/layouts/community/ergodox/albert/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'layouts/community/ergodox/albert/readme.md')
-rw-r--r--layouts/community/ergodox/albert/readme.md188
1 files changed, 188 insertions, 0 deletions
diff --git a/layouts/community/ergodox/albert/readme.md b/layouts/community/ergodox/albert/readme.md
new file mode 100644
index 000000000..e20e047ac
--- /dev/null
+++ b/layouts/community/ergodox/albert/readme.md
@@ -0,0 +1,188 @@
1# ErgoDox EZ Configuration for typing like a boss.
2
3This layout has 7 layers:
40. Base layers
51. Symbols and F-keys
62. Number pad (with hexadecimal)
73. Cursor keys
84. Mouse movement and clicks
95. Keyword macros
106. Emacs
11
12There are also some leader keys defined for frequently used commands (git etc).
13
14## The layers
15
16Double hashes (`##`) indicate transparent keys (`KC_TRNS`) and blanks indicate no key (`KC_NO`).
17
18### 0. Base layer
19
20```
21,--------------------------------------------------. ,--------------------------------------------------.
22| ESC | 1 | 2 | 3 | 4 | 5 | SfLt | | SfRt | 6 | 7 | 8 | 9 | 0 | BkSp |
23|--------|------|------|------|------|-------------| |------|------|------|------|------|------|--------|
24| Tab | Q | W | E | R | T | L1 | | L1 | Y | U | I | O | P | Del |
25|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
26| Caps/L2| A | S | D | F | G |------| |------| H | J | K | L | ; |Enter/L2|
27|--------|------|------|------|------|------| L6 | | L6 |------|------|------|------|------|--------|
28| LSft/( | Z | X | C | V/L3 | B/L4 | | | | N/L4 | M/L3 | , | . | / | RSft/) |
29`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
30 |Ctrl/[| Alt/]| # | Left |Right | | Up | Down | - | Alt/[|Ctrl/]|
31 `----------------------------------' `----------------------------------'
32 ,-------------. ,-------------.
33 | L2 | lead | | lead | Ins |
34 ,------|------|------| |------|------|------.
35 | Space| BkSp | Home | | PgUp | Enter|Space |
36 | / | / |------| |------| / | / |
37 | Ctrl | Alt |End/L5| |PDn/L5| Alt | Ctrl |
38 `--------------------' `--------------------'
39```
40
41Space Cadet shift is enabled. Ctrl and Alt doubles up as normal keys when tapped.
42SfLt and SfRt sends Shift + left and Shift + Right respectively - for use with emacs with `windmove-default-keybindings`.
43Caps and Enter may be held down to activate layer 2 (hexadecimal number pad).
44Please see `matrix_scan_user` function in `keymap.c` for list of commands available via `lead` key.
45
46### 1. Symbols and F-keys
47
48```
49,--------------------------------------------------. ,--------------------------------------------------.
50| ## | F1 | F2 | F3 | F4 | F5 | ## | | ## | F6 | F7 | F8 | F9 | F10 | F11 |
51|--------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
52| ## | ! | " | £ | $ | % | ## | | ## | - | + | = | @ | ~ | F12 |
53|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
54| ## | ^ | & | * | _ | # |------| |------| { | } | ; | ' | # | ## |
55|--------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
56| ## | \ | | | ` | - | / | | | | [ | ] | < | > | ? | ## |
57`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
58 | ## | ## | ## | ## | ## | | ## | ## | ## | ## | ## |
59 `----------------------------------' `----------------------------------'
60 ,-------------. ,-------------.
61 | ## | ## | | ## | ## |
62 ,------|------|------| |------|------|------.
63 | | | ## | | ## | | |
64 | ## | ## |------| |------| ## | ## |
65 | | | ## | | ## | | |
66 `--------------------' `--------------------'
67```
68
69### 2. Number pad (with hexadecimal)
70
71```
72,---------------------------------------------------. ,--------------------------------------------------.
73| ## | A | B | C | D | E | F | | A | B | C | D | E | F | ## |
74|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
75| ## | * | 7 | 8 | 9 | * | 0x | | 0x | * | 7 | 8 | 9 | * | ## |
76|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
77| ## | / | 4 | 5 | 6 | / |------| |------| / | 4 | 5 | 6 | / | ## |
78|---------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
79| ## | - | 1 | 2 | 3 | - | | | | - | 1 | 2 | 3 | - | ## |
80`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
81 | = | + | 0 | , | . | | 0 | , | . | + | = |
82 `-----------------------------------' `----------------------------------'
83 ,-------------. ,-------------.
84 | ## | ## | | ## | ## |
85 ,------|------|------| |------|------|------.
86 | | | ## | | ## | | |
87 | ## | ## |------| |------| ## | ## |
88 | | | ## | | ## | | |
89 `--------------------' `--------------------'
90```
91
92### 3. Cursor keys
93
94```
95,---------------------------------------------------. ,--------------------------------------------------.
96| | | | | | | | | | | | | | | |
97|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
98| | Home | | Up | | PgUp | | | | PgUp | | Up | | Home | |
99|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
100| | End | Left | Down | Right| PgDn |------| |------| PgDn | Left | Down | Right| End | |
101|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
102| ## | Up | | Down | ## | | | | | | ## | Down | | Up | ## |
103`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
104 | Left | Down | Right| | | | | | Left | Down | Right|
105 `-----------------------------------' `----------------------------------'
106 ,-------------. ,-------------.
107 | | | | | |
108 ,------|------|------| |------|------|------.
109 | | | | | | | |
110 | ## | ## |------| |------| ## | ## |
111 | | | | | | | |
112 `--------------------' `--------------------'
113```
114
115### 4. Mouse movement and clicks
116
117```
118,--------------------------------------------------. ,--------------------------------------------------.
119| | | | | | | | | | | | | | | |
120|--------|------|------|------|------|-------------| |------|------|------|------|------|------|--------|
121| | | Lclk | MsUp | Rclk | | | | | | Lclk | MsUp | Rclk | | |
122|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
123| | |MsLeft|MsDown|MsRght| |------| |------| |MsLeft|MsDown|MsRght| | |
124|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
125| Lclk | MsUp | Rclk |MsDown| | ## | | | | ## | |MsDown| Lclk | MsUp | Rclk |
126`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
127 |MsLeft|MsDown|MsRight | | | | |MsLeft|MsDown|MsRght|
128 `----------------------------------' `----------------------------------'
129 ,-------------. ,-------------.
130 | | | | | |
131 ,------|------|------| |------|------|------.
132 | | | | | | | |
133 | | |------| |------| | |
134 | | | | | | | |
135 `--------------------' `--------------------'
136```
137
138### 5. Keyword macros
139
140```
141,---------------------------------------------------. ,--------------------------------------------------.
142| | | | scarf| sadf | smily| | | | decaf| | | | | |
143|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
144| | const| volat| oper | ret | tmpl | | | | typen| cont | prv | pro | pub | |
145|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
146| | | str | obj | | gitl |------| |------| | | | nulp | | |
147|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
148| | | extr | cls | virt | break| | | |namesp| goodm| goodn| | | |
149`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
150 | | | inc | | | | | | | | |
151 `-----------------------------------' `----------------------------------'
152 ,-------------. ,-------------.
153 | | | | ecet | ecets|
154 ,------|------|------| |------|------|------.
155 | | | | | | | |
156 | | |------| |------| | |
157 | | | ## | | ## | | |
158 `--------------------' `--------------------'
159```
160Please see `keymap.c` for the keywords/commands.
161Some are const, volatile, operator, return, template, typename, continue, private,
162protected, public, struct, class, extern, virtual, break, namespace.
163Also a git log command I use a lot (`git log --oneline --graph --decorate=short` (I know git can be configured but that is boring)).
164
165### 6. Emacs
166
167```
168,---------------------------------------------------. ,--------------------------------------------------.
169| | | | | | | empb | | emnb | emfs | emfb | | | | |
170|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
171| | emtr | | | | | | | | emun | emre | w-up | | | |
172|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
173| | | emwr | | | |------| |------| |w-left|w-down|w-rght| | |
174|---------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
175| | | | | | | | | | | |w-down| | | |
176`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
177 | | | | | | | | | | | |
178 `-----------------------------------' `----------------------------------'
179 ,-------------. ,-------------.
180 | | | | | |
181 ,------|------|------| |------|------|------.
182 | | | | | | | |
183 | | |------| |------| | |
184 | | | | | | | |
185 `--------------------' `--------------------'
186```
187Some emacs shortcuts like toggle read/write mode (emtr), write file (emwr), previous-buffer (empb),
188next-buffer (emnb), smaller font(emfs), larger font (emfb), undo (emun), redo (emre) and switching between windows in a frame.
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-16 19:12:20 +0000