keyboards/frosty_flake/keymaps/QFR_JM/readme.md

   1 # TKL keymap for frosty_flake
   2
   3 ##Layers
   4
   5   ,----.    ,-------------------. ,-------------------. ,-------------------. ,--------------.
   6   |ESC |    | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
   7   '----'    '-------------------' '-------------------' '-------------------' '--------------'
   8   ,-------------------------------------------------------------------------. ,--------------.
   9   |  ` | 1  |  2 |  3 | 4  |  5 |  6 |  7 |  8 |  9 |  0 |  - |  = |  Bspc  | | Ins|Home|PgUp|
  10   |-------------------------------------------------------------------------| |--------------|
  11   | Tab  | Q  |  W | F  | P  | G  | J  | L  |  U |  Y | ;  | [  |  ] |   \  | | Del|End |PgDn|
  12   |-------------------------------------------------------------------------| '--------------'
  13   |  Bspc | A  | R  |  S |  T | D  | H  | N  | E  | I  | O  | '  |   Enter  |
  14   |-------------------------------------------------------------------------|      ,----.
  15   |   LSPO  | Z  | X  |  C | V  |  B |  K |  M |  , |  . |  / |    RSPC     |      | Up |
  16   |-------------------------------------------------------------------------| ,--------------.
  17   |Ctrl|LGUI|LAlt|             Space/Lower              |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
  18   '-------------------------------------------------------------------------' '--------------'
  19
  20 ### Base Layer - Colemak
  21         * The base layout is Colemak.
  22                         * I've implemented COLEMAK = SAFE_RANGE when enumerating the custom_keycodes, but I don't actually know what this does...
  23
  24         * Space cadet is implemented in the shift keys (hold for shift, tap for respective parentheses)
  25
  26         #### Layer Shifting
  27         * The spacebar is a **TAP_KEY** macro - Hold for momentary *LOWER* layer, Tap for Space.
  28         * The Right hand ALT key is a **TAP_TOGGLE** macro for the *MOUSE* layer (RAlt is accessible through LOWER, if you want...)
  29
  30 ### LOWER
  31
  32   ,----.    ,-------------------. ,-------------------. ,-------------------. ,--------------.
  33   |ESC |    | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
  34   '----'    '-------------------' '-------------------' '-------------------' '--------------'
  35   ,-------------------------------------------------------------------------. ,--------------.
  36   |  ~ | !  |  @ |  # |  $ |  % |  ^ |  & |  * |  ( |  ) |  _ |  + |  Bspc  | | Ins|Home|PgUp|
  37   |-------------------------------------------------------------------------| |--------------|
  38   | Tab  |PgUp|Home| Up | End|    |    |    |    |    |    | {  |  } |   |  | | Del|End |PgDn|
  39   |-------------------------------------------------------------------------| '--------------'
  40   | Bckspc|PgDn|Left|Down|Rght|    |    |    |    |    |    | '  |   Enter  |
  41   |-------------------------------------------------------------------------|      ,----.
  42   |   LSPO  | Z  | X  |  C | V  |    |    |    |  , |  . |  / |    RSPC     |      | Up |
  43   |-------------------------------------------------------------------------| ,--------------.
  44   |Ctrl|LGUI|LAlt|                                                  |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
  45   '-------------------------------------------------------------------------' '--------------'
  46
  47         * 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.
  48
  49         * 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.
  50
  51         * 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.
  52
  53 ### MOUSE
  54
  55   ,----.    ,-------------------. ,-------------------. ,-------------------. ,--------------.
  56   |ESC |    | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
  57   '----'    '-------------------' '-------------------' '-------------------' '--------------'
  58   ,-------------------------------------------------------------------------. ,--------------.
  59   |  ` | 1  |  2 |  3 | 4  |  5 |  6 |  7 |  8 |  9 |  0 |  - |  = |   Del  | | Ins|Home|PgUp|
  60   |-------------------------------------------------------------------------| |--------------|
  61   | Tab  | WhU| WhL| MsU| WhR|    |    | M3 | M4 | M5 |    | [  |  ] |   \  | | Del|End |PgDn|
  62   |-------------------------------------------------------------------------| '--------------'
  63   | BSPC  | WhD| MsL| MsD| MsR|    |    |LClk |RClk |    |    | '  |   Enter  |
  64   |-------------------------------------------------------------------------|      ,----.
  65   |   LSPO  | Z  | X  |  C | V  |    |    |    |  , |  . |  / |    RSPC     |      | Up |
  66   |-------------------------------------------------------------------------| ,--------------.
  67   |Ctrl|LGUI|LAlt|               Accel ++               |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
  68   '-------------------------------------------------------------------------' '--------------'
  69
  70         * The *MOUSE* layer contains keys replicating functions found on the mouse.
  71                 * 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.
  72                 * The primary click (right & left) buttons are on the right home row (index & middle fingers)
  73                 * Secondary click buttons are above the standard keys (M3/Wheel click, M4, M5) but I do not use this function.