keyboards/planck/keymaps/smt/readme.md

   1 # smt's Planck keymap
   2
   3 This keymap is primarily based on the default Planck keymap.
   4
   5 Notable differences from the default are:
   6
   7 - **[Mod-Tap](https://github.com/jackhumbert/qmk_firmware/wiki#fun-with-modifier-keys) keys**
   8
   9     - `Esc/Ctrl`
  10
  11         I am experimenting with using Left Shift as a mod-tap key for Escape, similar to how I use the Enter key. It's set up like this on my Minivan, so in the interest of consistency...
  12
  13     - `Enter/Shift`
  14
  15         I use both the left and right shift keys when I type. When I want to modify a key with shift, I hold shift with the hand opposite the one typing the key. In the default keymap, Enter is where shift would be on a standard keyboard layout. Oh, muscle memory.
  16
  17     - `Tab/Hyper` (Super+Ctrl+Shift+Alt)
  18
  19         It's great to be able to use Tab as a custom modifier key. I tend to use [Hyper](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/) commands for various OS-specific operations depending on what machine I'm working on.
  20
  21     - `Backtick/Meh` (Ctrl+Shift+Alt)
  22
  23         Why use backtick in the lower left corner? I use it as my tmux prefix key, so I need to type it more frequently than most people. Putting it on the base layer works well for me. The "Meh" mapping is just a less-cool "Hyper"; the same, just without Super.
  24
  25 - **Swapped responsibilities of "lower" and "raise" layers**
  26
  27     I prefer to use symbols via the "raise" layer, and numbers via the "lower" layer.
  28
  29 - **Removed Plover layer**
  30
  31     I don't intend to use stenography anytime soon, so Plover just didn't have a place in my keymap.
  32
  33
  34 ## Qwerty
  35
  36 ```
  37 ,-----------------------------------------------------------------------------------.
  38 | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  39 |------+------+------+------+------+-------------+------+------+------+------+------|
  40 | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  41 |------+------+------+------+------+------|------+------+------+------+------+------|
  42 | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  43 |------+------+------+------+------+------+------+------+------+------+------+------|
  44 |   `  | Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
  45 `-----------------------------------------------------------------------------------'
  46 ```
  47
  48 ## Colemak
  49
  50 ```
  51 ,-----------------------------------------------------------------------------------.
  52 | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  53 |------+------+------+------+------+-------------+------+------+------+------+------|
  54 | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  55 |------+------+------+------+------+------|------+------+------+------+------+------|
  56 | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  57 |------+------+------+------+------+------+------+------+------+------+------+------|
  58 |   `  | Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
  59 `-----------------------------------------------------------------------------------'
  60 ```
  61
  62 ## Dvorak
  63
  64 ```
  65 ,-----------------------------------------------------------------------------------.
  66 | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  67 |------+------+------+------+------+-------------+------+------+------+------+------|
  68 | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  -   |
  69 |------+------+------+------+------+------|------+------+------+------+------+------|
  70 | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  71 |------+------+------+------+------+------+------+------+------+------+------+------|
  72 |   `  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  73 `-----------------------------------------------------------------------------------'
  74 ```
  75
  76 ## Lower
  77
  78 This is where I put the number row, a numpad cluster, function keys, and media controls.
  79
  80 ```
  81 ,-----------------------------------------------------------------------------------.
  82 |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
  83 |------+------+------+------+------+-------------+------+------+------+------+------|
  84 |   $  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   4  |   5  |   6  |      |      |
  85 |------+------+------+------+------+------|------+------+------+------+------+------|
  86 |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   1  |   2  |   3  |      |      |
  87 |------+------+------+------+------+------+------+------+------+------+------+------|
  88 |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  89 `-----------------------------------------------------------------------------------'
  90 ```
  91
  92 ## Raise
  93
  94 As a developer, it makes the most sense for me to group all the commonly-used symbols that don't fit on the main layer. In particular, having the dual-column of parens-braces-brackets really helps a lot. I've also added cursorkeys to correspond to the arrows.
  95
  96 I haven't completely filled this layer, which leaves room for future mappings and macros.
  97
  98 ```
  99 ,-----------------------------------------------------------------------------------.
 100 |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
 101 |------+------+------+------+------+-------------+------+------+------+------+------|
 102 |      |      |      |      |      |      |   _  |   ?  |   +  |   {  |   }  |  |   |
 103 |------+------+------+------+------+------|------+------+------+------+------+------|
 104 |      |      |      |      |      |      |   -  |   /  |   =  |   [  |   ]  |  \   |
 105 |------+------+------+------+------+------+------+------+------+------+------+------|
 106 |      |      |      |      |      |      |      |      | Home |PageDn|PageUp| End  |
 107 `-----------------------------------------------------------------------------------'
 108 ```
 109
 110 ## Adjust (Lower + Raise)
 111
 112 Utility layer. This is where I'd switch between Qwerty and Dvorak, ~~fool around with~~ adjust the audio/music settings, or put the Planck into bootloader mode.
 113
 114 ```
 115 ,-----------------------------------------------------------------------------------.
 116 |      | Reset|      |      |      |      |      |      |      |      |      | Reset|
 117 |------+------+------+------+------+-------------+------+------+------+------+------|
 118 |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
 119 |------+------+------+------+------+------|------+------+------+------+------+------|
 120 |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 121 |------+------+------+------+------+------+------+------+------+------+------+------|
 122 |      |      |      |      |      |             |      |      |      |      |      |
 123 `-----------------------------------------------------------------------------------'
 124 ```