keyboards/kmac/keymaps/winkeyless/readme.md

   1 # Keymap for the winkeyless version of KMAC
   2
   3 This is the default keymap for the winkeyless version of the PCB. It implements the same features as the official default KMAC firmware.
   4
   5
   6 See [keymap.c](keymap.c) for details.
   7
   8 ## Layers
   9
  10 The keymap have two layers. To access the functions on the second layer, hold down `Fn` and press the corresponding key.
  11
  12 ### Layer 1: Default Layer
  13      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  14      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  15      `---'   `---------------' `---------------' `---------------' `-----------'
  16      ,-----------------------------------------------------------. ,-----------.
  17      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
  18      |-----------------------------------------------------------| |-----------|
  19      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
  20      |-----------------------------------------------------------| '-----------'
  21      |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  22      |-----------------------------------------------------------|     ,---.
  23      |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
  24      |-----------------------------------------------------------| ,-----------.
  25      |Ctl|Gui|Alt|               Space               |Alt|Fn |Ctl| |Lef|Dow|Rig|
  26      `-----------------------------------------------------------' `-----------'
  27
  28 ### Layer 2: Function Layer
  29      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  30      |Led|   |M1 |M2 |M3 |M4 | |M5 |M6 |M7 |M8 | |M9 |M10|M11|M12| |   |   |   |
  31      `---'   `---------------' `---------------' `---------------' `-----------'
  32      ,-----------------------------------------------------------. ,-----------.
  33      |   |   |   |   |   |   |   |   |   |   |   |   |   |       | |   |   |   |
  34      |-----------------------------------------------------------| |-----------|
  35      |     |   |   |   |   |   |   |   |   |   |   |   |   |     | |   |   |   |
  36      |-----------------------------------------------------------| '-----------'
  37      |      |   |   |   |   |   |   |   |   |   |   |   |        |
  38      |-----------------------------------------------------------|     ,---.
  39      |        |   |   |   |   |   |   |   |   |   |   |          |     |   |
  40      |-----------------------------------------------------------| ,-----------.
  41      |   |   |   |                                   |   |   |   | |   |   |   |
  42      `-----------------------------------------------------------' `-----------'
  43
  44 ## Macros
  45
  46 These are mostly useless and serve more like examples I guess.
  47
  48 | Macro | Action                                 |
  49 |:-----:| -------------------------------------- |
  50 | 1     | Types `The`                            |
  51 | 2     | Types `Custom`                         |
  52 | 3     | Types `Keyboard`                       |
  53 | 4     | Inputs `<Ctrl+c>` `<Right>` `<Ctrl+v>` |
  54
  55 ## Building
  56
  57 To build the firmware with the keymap for the winkeyless version, run `make winkeyless`.