summaryrefslogtreecommitdiff
path: root/keyboards/frosty_flake/keymaps/QFR_JM/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/frosty_flake/keymaps/QFR_JM/readme.md')
-rw-r--r--keyboards/frosty_flake/keymaps/QFR_JM/readme.md53
1 files changed, 33 insertions, 20 deletions
diff --git a/keyboards/frosty_flake/keymaps/QFR_JM/readme.md b/keyboards/frosty_flake/keymaps/QFR_JM/readme.md
index 6c7fabd185..396337440e 100644
--- a/keyboards/frosty_flake/keymaps/QFR_JM/readme.md
+++ b/keyboards/frosty_flake/keymaps/QFR_JM/readme.md
@@ -1,7 +1,15 @@
-# TKL keymap for frosty_flake
-##Layers
+# TKL keymap for frosty\_flake
+```
+make frosty_flake:QFR_JM
+
+dfu-programmer atmega32u2 erase
+dfu-programmer atmega32u2 flash frosty_flake_QFR_JM.hex
+dfu-programmer atmega32u2 start
+```
+##Layers
+```
,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
|ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
'----' '-------------------' '-------------------' '-------------------' '--------------'
@@ -17,20 +25,21 @@
|Ctrl|LGUI|LAlt| Space/Lower |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
'-------------------------------------------------------------------------' '--------------'
+```
### Base Layer - Colemak
- * The base layout is Colemak.
- * I've implemented COLEMAK = SAFE_RANGE when enumerating the custom_keycodes, but I don't actually know what this does...
+The base layout is Colemak by default, but this can be changed to QWERTY via the *LOWER* layer.
+* I've implemented COLEMAK = SAFE\_RANGE when enumerating the custom\_keycodes, but I don't actually know what this does...
- * Space cadet is implemented in the shift keys (hold for shift, tap for respective parentheses)
+* Space cadet is implemented in the shift keys (hold for shift, tap for respective parentheses)
- #### Layer Shifting
- * The spacebar is a **TAP_KEY** macro - Hold for momentary *LOWER* layer, Tap for Space.
- * The Right hand ALT key is a **TAP_TOGGLE** macro for the *MOUSE* layer (RAlt is accessible through LOWER, if you want...)
+#### Layer Shifting
+* The spacebar is a **TAP_KEY** macro - Hold for momentary *LOWER* layer, Tap for Space.
+* The Right hand ALT key is a **TAP_TOGGLE** macro for the *MOUSE* layer (RAlt is accessible through LOWER, if you want...)
### LOWER
-
+```
,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
- |ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
+ |ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |QWTY|CLMK|PsBk|
'----' '-------------------' '-------------------' '-------------------' '--------------'
,-------------------------------------------------------------------------. ,--------------.
| ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | _ | + | Bspc | | Ins|Home|PgUp|
@@ -41,17 +50,19 @@
|-------------------------------------------------------------------------| ,----.
| LSPO | Z | X | C | V | | | | , | . | / | RSPC | | Up |
|-------------------------------------------------------------------------| ,--------------.
- |Ctrl|LGUI|LAlt| |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
+ |Ctrl|LGUI|LAlt| |RAlt|RGUI|Menu|Ctrl| |Left|Down|Rght|
'-------------------------------------------------------------------------' '--------------'
-
- * The *LOWER* layer contains a navigation cluster on the left hand. This layer is momentary when the spacebar or LOWER (RAlt) key is held and toggled on/off when the LOWER key is tapped.
+```
+The *LOWER* layer contains a navigation cluster on the left hand. This layer is momentary when the spacebar or LOWER (RAlt) key is held and toggled on/off when the LOWER key is tapped.
- * The Navigation cluster is offset to the right compared to the traditional **WASD** nav cluster. With this implementation, you don't need to move your hand from the home position when navigating. Page Up & Down keys are found on the far left of the cluster.
+* The Navigation cluster is offset to the right compared to the traditional **WASD** nav cluster. With this implementation, you don't need to move your hand from the home position when navigating. Page Up & Down keys are found on the far left of the cluster.
- * All unused (blank on the above keymap) keys are locked out using the XXXXXXX filler (KC_NO), all modifiers (edge |_| keys \[except 0, \. & Fn\] on the above keymap) and the ZXCV cluster are transparent (_______) to the Base layer.
+* All unused (blank on the above keymap) keys are locked out using the XXXXXXX filler (KC\_NO), all modifiers (edge |\_| keys \[except 0, \. & Fn\] on the above keymap) and the ZXCV cluster are transparent (\_\_\_\_\_\_\_) to the Base layer.
-### MOUSE
+* The base layer can be switched to QWERTY or COLEMAK by pressing the Pause Break or Scroll Lock keys respectively
+### MOUSE
+```
,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
|ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
'----' '-------------------' '-------------------' '-------------------' '--------------'
@@ -66,8 +77,10 @@
|-------------------------------------------------------------------------| ,--------------.
|Ctrl|LGUI|LAlt| Accel ++ |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
'-------------------------------------------------------------------------' '--------------'
+```
+The *MOUSE* layer contains keys replicating functions found on the mouse.
+
+* The navigation cluster (Up, Down, Left, Right) is a replication of the Navigation cluster on the *LOWER* layer. The scroll keys are analagous to the Page Up & Downkeys.
+* The primary click (right & left) buttons are on the right home row (index & middle fingers)
+* Secondary click buttons are above the standard keys (M3/Wheel click, M4, M5) but I do not use this function.
- * The *MOUSE* layer contains keys replicating functions found on the mouse.
- * The navigation cluster (Up, Down, Left, Right) is a replication of the Navigation cluster on the *LOWER* layer. The scroll keys are analagous to the Page Up & Down keys.
- * The primary click (right & left) buttons are on the right home row (index & middle fingers)
- * Secondary click buttons are above the standard keys (M3/Wheel click, M4, M5) but I do not use this function.