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
   6   differently depending on whether they are tapped or held, keys that react
   7   differently if they are double tapped, etc. should be avoided -- they
   8   inevitably send their keycode later than a normal key -- interrupting the
   9   immediate feedback from the screen. Therefore we restrict ourselves to
  10   chording as our only means of getting more than one symbol out of a single
  11   physical key.
  12
  13 - The hands should never need to leave the home position. The usual culprit for
  14   this is the arrow cluster, so the arrow cluster should be as close to home as
  15   possible.
  16
  17 - There should be two of every modifier (one on each side), otherwise certain
  18   long key combinations become hard to make.
  19
  20 Keys are arranged as follows. Blank keys below may actually contain
  21 undocumented shortcuts specific to my workflow. The base layer can be set to
  22 colemak or qwerty (from the function layer).
  23
  24 ```
  25 /* COLEMAK
  26  * ,-----------------------------------------------------------------------.
  27  * |Tab  |  Q  |  W  |  F  |  P  |  G  |  J  |  L  |  U  |  Y  |  ;  |  -  |
  28  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  29  * |Bksp |  A  |  R  |  S  |  T  |  D  |  H  |  N  |  E  |  I  |  O  |  '  |
  30  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  31  * |Shift|  Z  |  X  |  C  |  V  |  B  |  K  |  M  |  ,  |  .  |  /  |Shift|
  32  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  33  * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
  34  * `-----------------------------------------------------------------------'
  35  */
  36
  37 /* QWERTY
  38  * ,-----------------------------------------------------------------------.
  39  * |Tab  |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  -  |
  40  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  41  * |Bksp |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |
  42  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  43  * |Shift|  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  |Shift|
  44  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  45  * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
  46  * `-----------------------------------------------------------------------'
  47  */
  48
  49 /* SYMB
  50  * ,-----------------------------------------------------------------------.
  51  * | Esc |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |     |
  52  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  53  * | Del |  !  |  @  |  #  |  $  |  %  |  ^  |  &  |  *  |  (  |  )  |     |
  54  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  55  * |     |  ~  |  `  |  +  |  =  |  |  |  \  |  [  |  ]  |  {  |  }  |     |
  56  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  57  * |     |     |     |     |     |     |     |     |     |     |     |     |
  58  * `-----------------------------------------------------------------------'
  59  */
  60
  61 /* MOVE
  62  * ,-----------------------------------------------------------------------.
  63  * |     |     |     |     |     |     |     |Home | Up  | End |     | Esc |
  64  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  65  * |     |     |     |     |     |     |     |Left |Down |Right|Caps | Del |
  66  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  67  * |     |     |     |     |     |     |     |PgDn |PgUp |     |     |     |
  68  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  69  * |     |     |     |     |     |     |     |     |     |     |     |     |
  70  * `-----------------------------------------------------------------------'
  71  */
  72
  73 /* FUNC
  74  * ,-----------------------------------------------------------------------.
  75  * |Reset| F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 |VolUp|
  76  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  77  * |Power| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 |VolDn|
  78  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  79  * |     | F21 | F22 | F23 | F24 |     |     |     |     |COLMK|QWRTY|     |
  80  * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
  81  * |     |     |     |     |Prev |Mute |Play |Next |     |     |     |     |
  82  * `-----------------------------------------------------------------------'
  83  */
  84  ```