keyboards/frosty_flake/keymaps/QFR_JM/readme.md

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