keyboards/planck/keymaps/yttyx/readme.md

   1 # Overview
   2
   3 * Base layer uses the Balance Twelve layout ([reference](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/))
   4 * Plover layer uses the same home position as the base layer ([reference](http://www.openstenoproject.org/))
   5
   6 ## To build
   7
   8 ```
   9 make planck/rev6:yttyx
  10 ```
  11
  12 ## To build and flash
  13
  14 ```
  15 make planck/rev6:yttyx:dfu-util
  16 ```
  17
  18 ## Layers
  19
  20 ### Base
  21
  22     .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
  23     | P      | L      | C      | D      | W      |        |        | U      | O      | Y      | K      | Q      |
  24     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  25     | N      | R      | S      | T      | M      |        | BS     | A      | E      | I      | H      | V      |
  26     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  27     | Z Sft  | J      | F      | G      | B      |        | Ent    | ' @    | , <    | . >    | X Sft  |        |
  28     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  29     | Ctl    | Alt    | Sup    | NP     | Spc    | Esc/FC | Sft    | Sft    | Sup    | Alt    | Ctl    |        |
  30     '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
  31
  32 ### Plover
  33
  34     .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
  35     | #      | #      | #      | #      | #      | BA     | #      | #      | #      | #      | #      | #      |
  36     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  37     | S      | T      | P      | H      | *      |        | *      | F      | P      | L      | T      | D      |
  38     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  39     | S      | K      | W      | R      | *      |        | *      | R      | B      | G      | S      | Z      |
  40     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  41     |        |        |        | A      | O      |        | E      | U      |        |        |        |        |
  42     '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
  43
  44 ### Numeric/Punctuation
  45
  46     .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
  47     | 1 !    | 2 "    | 3 £    | 4 $    | 5 %    | PL     |        | 6 ^    | 7 &    | 8 *    | 9 (    | 0 )    |
  48     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  49     | Tab    | Ctl-X  | Ctl-C  | Ctl-V  | Ctl-Z  |        | BS     | [ {    | ] }    | - _    | ; :    | \ |    |
  50     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  51     | Sft    |        |        | Del    | Ins    |        |        | / ?    | = +    | # ~    | `      |        |
  52     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  53     | Ctl    | Alt    | Sup    | NP     | Spc    |        | Sft    | Sft    | Sup    | Alt    | Ctl    |        |
  54     '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
  55
  56 ### Function
  57
  58     .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
  59     | F1     | F2     | F3     | F4     | F5     |        |        | Home   | Up     | End    | PgUp   |        |
  60     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  61     | F6     | F7     | F8     | F9     | F10    |        |        | Left   | Down   | Right  | PgDn   |        |
  62     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  63     | Sft    |        |        | F11    | F12    |        |        | PScr   | Break  | ScLk   | Caps   |        |
  64     |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
  65     | Ctl    | Alt    | Sup    |        | Spc    |        | Sft    | Sft    | Sup    | Alt    | Ctl    |        |
  66     '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
  67
  68