keyboard/kmac/README.md

   1 KMAC keyboard firmware
   2 ======================
   3 Korean custom keyboard designed by Byungho Kim and KBDMania community.
   4
   5 *Note that this is not the official firmware*
   6
   7 Supported models
   8 ----------------
   9 At the moment only the TKL models is supported.
  10
  11
  12 Build
  13 -----
  14 Move to this directory then just run `make` like:
  15
  16     $ make -f Makefile.[pjrc|lufa] [winkey|winkeyless]
  17
  18 Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
  19
  20
  21 Bootloader
  22 ---------
  23 The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard.
  24
  25 It is still possible to use Boot Magic and Command to access the bootloader though.
  26
  27
  28 Keymap
  29 ------
  30 There are 2 different types of PCB.
  31 They each have their own keymap file.
  32
  33 To customize a keymap:
  34     1. Edit the file that corresponds to your PCB.
  35     2. Specify your layout when building.
  36
  37 ### 1. Winkey
  38 This is the default keymap.
  39
  40 See [keymap_winkey.h](keymap_winkey.h) for detail.
  41
  42 #### 1.0. Winkey Default Layer
  43      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  44      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  45      `---'   `---------------' `---------------' `---------------' `-----------'
  46      ,-----------------------------------------------------------. ,-----------.
  47      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
  48      |-----------------------------------------------------------| |-----------|
  49      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
  50      |-----------------------------------------------------------| '-----------'
  51      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  52      |-----------------------------------------------------------|     ,---.
  53      |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
  54      |-----------------------------------------------------------| ,-----------.
  55      |Ctl|Gui|Alt|             Space             |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
  56      `-----------------------------------------------------------' `-----------'
  57
  58 #### 1.1. Winkey Media Layer
  59      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  60      |Led|   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
  61      `---'   `---------------' `---------------' `---------------' `-----------'
  62      ,-----------------------------------------------------------. ,-----------.
  63      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
  64      |-----------------------------------------------------------| |-----------|
  65      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|Media| |   |   |   |
  66      |-----------------------------------------------------------| '-----------'
  67      |      |   |   |   |   |   |   |   |   |   |   |   |        |
  68      |-----------------------------------------------------------|     ,---.
  69      |        |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
  70      |-----------------------------------------------------------| ,-----------.
  71      |   |   |   |                               |   |   |   |   | |   |   |   |
  72      `-----------------------------------------------------------' `-----------'
  73
  74
  75 ### 2. Winkeyless
  76 Layout with 1.5 unit modifiers.
  77
  78 See [keymap_winkeyless.h](keymap_winkeyless.h) for detail.
  79
  80 #### 2.0. Winkeyless Default Layer
  81      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  82      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  83      `---'   `---------------' `---------------' `---------------' `-----------'
  84      ,-----------------------------------------------------------. ,-----------.
  85      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
  86      |-----------------------------------------------------------| |-----------|
  87      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
  88      |-----------------------------------------------------------| '-----------'
  89      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  90      |-----------------------------------------------------------|     ,---.
  91      |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
  92      |-----------------------------------------------------------| ,-----------.
  93      |Ctl |Gui|Alt |             Space             |Alt |Gui|Ctl | |Lef|Dow|Rig|
  94      `-----------------------------------------------------------' `-----------'
  95
  96 #### 2.1. Winkeyless Media Layer
  97      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  98      |Led|   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
  99      `---'   `---------------' `---------------' `---------------' `-----------'
 100      ,-----------------------------------------------------------. ,-----------.
 101      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
 102      |-----------------------------------------------------------| |-----------|
 103      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|Media| |   |   |   |
 104      |-----------------------------------------------------------| '-----------'
 105      |      |   |   |   |   |   |   |   |   |   |   |   |        |
 106      |-----------------------------------------------------------|     ,---.
 107      |        |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
 108      |-----------------------------------------------------------| ,-----------.
 109      |    |   |    |                               |    |   |    | |   |   |   |
 110      `-----------------------------------------------------------' `-----------'