summaryrefslogtreecommitdiff
path: root/keyboards/crkbd/keymaps/colemad/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/crkbd/keymaps/colemad/readme.md')
-rw-r--r--keyboards/crkbd/keymaps/colemad/readme.md106
1 files changed, 106 insertions, 0 deletions
diff --git a/keyboards/crkbd/keymaps/colemad/readme.md b/keyboards/crkbd/keymaps/colemad/readme.md
new file mode 100644
index 0000000000..404fa9e798
--- /dev/null
+++ b/keyboards/crkbd/keymaps/colemad/readme.md
@@ -0,0 +1,106 @@
+# **COLEMAD**
+
+## Corne Keyboard (CRKBD) **Colemak** layout by [ACortesDev](https://github.com/ACortesDev)
+
+1. **Fast navigation**.
+2. **Fast symbols**.
+3. **Fast numbers**.
+ Using the Telephone/ATM numpad layout. Easier to memorize/visualize as numbers follow *left-to-right, top-to-bottom* order.
+4. **Fast capital letters**.
+ Added a *CAPS Lock* key because... [There is no *CAPS Lock* key in the Colemak Layout](https://colemak.com/FAQ#Where_is_the_Caps_Lock_key.3F).
+
+---
+
+### **Flashing**
+
+For *Pro Micro* execute: `sudo make crkbd:colemad:avrdude`
+
+For *Elite-C* execute: `sudo make crkbd:colemad:dfu`
+
+---
+
+### **Layers**
+
+#### 0. **COLEMAK**
+
+Notes:
+
+- Double tap Shift to (de)activate CAPS Lock.
+- Hold down the Enter thumb key to switch to the LOWER layer
+- Hold down the Space thumb key to switch to the RAISE layer
+- Characters **"** **:** **|** **<** **>** **?** as you would expect them using *Shift*.
+
+```text
+ ,-----------------------------------------------------. ,-----------------------------------------------------.
+ | Tab | Q | W | F | P | G | | J | L | U | Y | ; | \ |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | BackSP | A | R | S | T | D | | H | N | E | I | O | ' |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | Shift | Z | X | C | V | B | | K | M | , | . | / | ESC |
+ `--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------'
+ ,--------. ,--------.
+ ,-----------------| | | |-----------------.
+ | Alt | Ctrl | Space | | Enter | Shift | GUI |
+ | | | (RAISE)| |(LOWER) | | |
+ `--------+--------+--------' `--------+--------+--------'
+```
+
+#### 1. **LOWER**
+
+##### Numpad + Navigation
+
+```text
+ ,-----------------------------------------------------. ,-----------------------------------------------------.
+ | Tab | 0 | 1 | 2 | 3 | - | | PgUP | HOME | ↑ | END | ESC | |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | BackSP | / | 4 | 5 | 6 | + | | PgDN | ← | ↓ | → | DEL | |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | Shift | * | 7 | 8 | 9 | = | | | | | | | ESC |
+ `--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------'
+ ,--------. ,--------.
+ ,-----------------| | | |-----------------.
+ | Alt | Ctrl | Space | | | Shift | GUI |
+ | | | (RAISE)| |(LOWER) | | |
+ `--------+--------+--------' `--------+--------+--------'
+```
+
+#### 2. **RAISE**
+
+##### Symbols + Function Keys
+
+```text
+ ,-----------------------------------------------------. ,-----------------------------------------------------.
+ | Tab | ! | @ | # | $ | % | | ^ | & | * | ( | ) | F11 |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | BackSP | F1 | F2 | F3 | F4 | F5 | | ` | - | = | [ | ] | F12 |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | Shift | F6 | F7 | F8 | F9 | F10 | | ~ | _ | + | { | } | ESC |
+ `--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------'
+ ,--------. ,--------.
+ ,-----------------| | | |-----------------.
+ | Alt | Ctrl | | | Enter | Shift | GUI |
+ | | | (RAISE)| |(LOWER) | | |
+ `--------+--------+--------' `--------+--------+--------'
+```
+
+#### 3. **ADJUST**
+
+##### Macros + Settings
+
+```text
+ ,-----------------------------------------------------. ,-----------------------------------------------------.
+ | | | | | | | |RGB_TOG |RGB_MOD |RGB_VAI |RGB_HUI |RGB_SAI |RGB_SPI |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | | |VSCTERM | PSCR |CHNLANG | | | |RGB_RMOD|RGB_VAD |RGB_HUD |RGB_SAD |RGB_SPD |
+ |--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
+ | | | | | | | | | | | | | |
+ `--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------'
+ ,--------. ,--------.
+ ,-----------------| | | |-----------------.
+ | | | | | | | |
+ | | | (RAISE)| |(LOWER) | | |
+ `--------+--------+--------' `--------+--------+--------'
+```
+
+- Macro **VSCTERM**: Toggles the vscode terminal (Ctrl + `)
+- Macro **CHNLANG**: Changes the OS keyboard layout (Ctrl + Shift + N)