keyboards/planck/keymaps/cbbrowne/readme.md

   1 cbbrowne custom keyboard
   2 ==============================
   3
   4 Due to cbbrowne@acm.org
   5 Christopher Browne
   6
   7 This was originally based on the default keyboard map, but I have been
   8 doing sundry experimentation:
   9
  10 1. Experiments
  11 ----------------------------------------
  12
  13  * To figure things out about the toolset
  14  * I'm an Emacs guy, so will be needing a fair bit of tuning
  15  * It made sense to mess around some with keyboard maps.
  16    - I tried added Workman alongside Dvorak and Colemak
  17      - Boy, oh boy, these don't help!!!
  18      - I have done 30 years of learning of Emacs key mappings, and
  19        these alternative keyboards massively mess me up
  20    - I added a keypad, originally based on keymaps/numpad.c, but
  21      mighty substantially revised, as that one seems to be rotated 90
  22      degrees from usual conventions for number pads
  23  * The keypad layer also includes some sample "hacks" of cool things,
  24    all using actions attached in using the function action_get_macro()
  25    - Key [1][2] aka "q" types out my name, cbbrowne, as a fun example
  26      of a key generating a bunch of keystrokes.  The keystroke is
  27      sufficiently inconvenient that it isn't terribly practical for me
  28      to use it, but hey, it shows how others might use this facility
  29      in a more useful context.
  30    - Key [2][2] aka "a" uses a random number generator to select a digit 0-9 at random
  31    - Key [3][2] aka "z" uses a random number generator to select a letter a-z at random
  32    - Key [1][3] aka "e" spits out the keymap version number
  33
  34 2. Some code structure ideas
  35 ---------------------------------------------------
  36
  37    Each layer is given a name to aid in readability, which is then
  38    used in the keymap matrix below.  The underscores do not denote
  39    anything - you can have a layer called STUFF or any other name.
  40
  41    Layer names don't all need to be of the same length, obviously, and
  42    you could also skip them entirely and just use numbers, though that
  43    means needing to manage the numbers.
  44
  45    It is preferable to keep the symbols short so that a line worth of
  46    key mappings fits compactly onto a line of code.  It might be an
  47    interesting idea to express the maps rotated 90%, so that you
  48    only need to fit 4 symbols onto each line, rather than 12.
  49
  50    I used enums to manage layer IDs and macro IDs so that I don't need
  51    to care (beyond "start at 0", and arguably that's not needed) about
  52    their values.
  53
  54 3. Things I did not like about the default mapping
  55 ---------------------------------------------------------
  56
  57    * I found control too hard to get to.  I use it more than Tab, so
  58      switched it there.
  59    * Having dash on [lower-j] is a bit nonintuitive, but may be OK
  60    * I switched ESC/TAB/M(0) around
  61    * I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
  62      and shift ESC off the first column so KC_LCTL and KC_LALT can
  63      be on the first column.
  64    * I needed to swap ' and ENTER