keyboards/kmac/keymaps/default/readme.md

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