keyboards/planck/keymaps/callum/readme.md

   1 # callum’s planck layout
   2
   3 This is a layout for the grid planck, built with a few ideals in mind:
   4
   5 - Consistent and minimal response times should be maintained. Keys that react differently depending on whether they are tapped or held, keys that react differently if they are double tapped, etc. should be avoided – they inevitably send their keycode later than a normal key – interrupting the immediate feedback from the screen. Therefore we restrict ourselves to chording as our only means of getting more than one symbol out of a single physical key.
   6 - The hands should never need to leave the home position. The usual culprit for this is the arrow cluster, so the arrow cluster should be as close to home as possible.
   7 - There should be two of every modifier (one on each side), otherwise certain long key combinations become hard to make.
   8
   9 We have five layers. A `BASE` layer, in colemak; a `MOVE` layer, with an arrow cluster and other movement keys; a `SYMB` layer, with numbers and symbols; a `FUNC` layer, with function keys and media keys; and a `MOUSE` layer, with mouse emulation. The `MOUSE` layer is activated by holding the Move and Symb keys simultaniously.
  10
  11 ```
  12 /* BASE
  13  * ,-----------------------------------------------------------------------------------.
  14  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  -   |
  15  * |------+------+------+------+------+------+------+------+------+------+------+------|
  16  * | Bksp |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  17  * |------+------+------+------+------+------+------+------+------+------+------+------|
  18  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  | Shift|
  19  * |------+------+------+------+------+------+------+------+------+------+------+------|
  20  * | Func | Ctrl |  Alt |  Cmd | Symb | Enter| Space| Move |  Cmd |  Alt | Ctrl | Func |
  21  * `-----------------------------------------------------------------------------------'
  22  */
  23
  24 /* MOVE
  25  * ,-----------------------------------------------------------------------------------.
  26  * |  Esc |      | Cmd-L|  Up  | Cmd-R|      |      | Cmd-L|  Up  | Cmd-R|      |  Esc |
  27  * |------+------+------+------+------+------+------+------+------+------+------+------|
  28  * |  Del | Caps | Left | Down | Right|      |      | Left | Down | Right| Caps |  Del |
  29  * |------+------+------+------+------+------+------+------+------+------+------+------|
  30  * |      |      |      | Pg Up| Pg Dn|      |      | Pg Dn| Pg Up|      |      |      |
  31  * |------+------+------+------+------+------+------+------+------+------+------+------|
  32  * |      |      |      |      |      |      |      |      |      |      |      |      |
  33  * `-----------------------------------------------------------------------------------'
  34  */
  35
  36 /* SYMB
  37  * ,-----------------------------------------------------------------------------------.
  38  * |  Esc |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   –  |
  39  * |------+------+------+------+------+------+------+------+------+------+------+------|
  40  * |  Del |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |   £  |
  41  * |------+------+------+------+------+------+------+------+------+------+------+------|
  42  * |      |   ~  |   `  |   +  |   =  |   |  |   \  |   [  |   ]  |   {  |   }  |      |
  43  * |------+------+------+------+------+------+------+------+------+------+------+------|
  44  * |      |      |      |      |      |      |      |      |      |      |      |      |
  45  * `-----------------------------------------------------------------------------------'
  46  */
  47
  48 /* MOUSE
  49  * ,-----------------------------------------------------------------------------------.
  50  * |      |      | ACC-2| ACC-1| ACC-0|      |      | SW-L |  M-U | SW-R |      |      |
  51  * |------+------+------+------+------+------+------+------+------+------+------+------|
  52  * |      |      | MB-3 | MB-2 | MB-1 |      |      |  M-L |  M-D |  M-R |      |      |
  53  * |------+------+------+------+------+------+------+------+------+------+------+------|
  54  * |      |      |      |      |      |      |      | SW-D | SW-U |      |      |      |
  55  * |------+------+------+------+------+------+------+------+------+------+------+------|
  56  * |      |      |      |      |      |      |      |      |      |      |      |      |
  57  * `-----------------------------------------------------------------------------------'
  58  */
  59
  60 /* FUNC
  61  * ,-----------------------------------------------------------------------------------.
  62  * | Reset|  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 | Vol+ |
  63  * |------+------+------+------+------+------+------+------+------+------+------+------|
  64  * |      |  F11 |  F12 |  F13 |  F14 |  F15 |  F16 |  F17 |  F18 |  F19 |  F20 | Vol- |
  65  * |------+------+------+------+------+------+------+------+------+------+------+------|
  66  * |      |  F21 |  F22 |  F23 |  F24 |      |      | Power|      |      |      |      |
  67  * |------+------+------+------+------+------+------+------+------+------+------+------|
  68  * |      |      |      |      | Prev | Mute | Play | Next |      |      |      |      |
  69  * `-----------------------------------------------------------------------------------'
  70  */
  71  ```