keyboard/gh60/README.md

   1 GH60 keyboard firmware
   2 ======================
   3 DIY compact keyboard designed and run by komar007 and Geekhack community.
   4
   5 ## Threads on Geekhack.org
   6 - [Prototyping](http://geekhack.org/index.php?topic=34959.0)
   7 - [Beta-test](http://geekhack.org/index.php?topic=37570.0)
   8
   9
  10 ## Build
  11 Move to this directory then just run `make` like:
  12
  13    $ make -f Makfile.[pjrc|lufa]
  14
  15 Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
  16
  17
  18 ## Boot Magic
  19 Plugin pressing these `Boot Magic` key.
  20
  21 - `Fn` key for bootloader kick up.
  22 - `D` key for Debug enable.
  23
  24
  25 ## Keymap
  26 Two version of keymap are available. `Plan`, `Poker` and `Funky`(default).
  27 See keymap.c to define your own favourite keymap.
  28
  29     $ make -f Makefile.[pjrc|lufa] [plain|poker]
  30
  31 ### 1. Plain keymap
  32 This will be useful if you want to use key mapping tool like AHK.
  33
  34 See [keymap_plain.h](keymap_plain.h) for detail.
  35
  36 #### 1.0 Plain Default Layer
  37     ,-----------------------------------------------------------.
  38     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  39     |-----------------------------------------------------------|
  40     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  41     |-----------------------------------------------------------|
  42     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  43     |-----------------------------------------------------------|
  44     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  45     |-----------------------------------------------------------|
  46     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
  47     `-----------------------------------------------------------'
  48
  49 ### 2  Poker keymap
  50 Poker layer emulation
  51
  52 See [keymap_poker.h](keymap_poker.h) for detail.
  53
  54 #### 2.0 Poker Default Layer
  55     ,-----------------------------------------------------------.
  56     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  57     |-----------------------------------------------------------|
  58     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  59     |-----------------------------------------------------------|
  60     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  61     |-----------------------------------------------------------|
  62     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  63     |-----------------------------------------------------------|
  64     |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
  65     `-----------------------------------------------------------'
  66
  67 #### 2.1 Poker Arrow Layer
  68     ,-----------------------------------------------------------.
  69     |   |   |   |   |   |   |   |   |   |   |   |   |   |       |
  70     |-----------------------------------------------------------|
  71     |     |   |   |   |   |   |   |   |   |   |   |   |   |     |
  72     |-----------------------------------------------------------|
  73     |      |   |   |   |   |   |   |   |   |   |   |   |        |
  74     |-----------------------------------------------------------|
  75     |        |   |   |   |   |   |   |   |   |   |   |  Up      |
  76     |-----------------------------------------------------------|
  77     |    |    |    |                        |Fn  |Left|Down|Righ|
  78     `-----------------------------------------------------------'
  79
  80 #### 2.2 Poker Esc Layer
  81     ,-----------------------------------------------------------.
  82     |Esc|   |   |   |   |   |   |   |   |   |   |   |   |       |
  83     |-----------------------------------------------------------|
  84     |     |   |   |   |   |   |   |   |   |   |   |   |   |     |
  85     |-----------------------------------------------------------|
  86     |      |   |   |   |   |   |   |   |   |   |   |   |        |
  87     |-----------------------------------------------------------|
  88     |        |   |   |   |   |   |   |   |   |   |   |          |
  89     |-----------------------------------------------------------|
  90     |    |    |    |                        |Fn  |    |    |    |
  91     `-----------------------------------------------------------'
  92
  93 #### 2.1 Poker Fn Layer
  94     ,-----------------------------------------------------------.
  95     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
  96     |-----------------------------------------------------------|
  97     |     |FnQ| Up|   |   |   |   |   |   |Cal|   |Hom|Ins|     |
  98     |-----------------------------------------------------------|
  99     |      |Lef|Dow|Rig|   |   |Psc|Slk|Pau|   |Tsk|End|        |
 100     |-----------------------------------------------------------|
 101     |        |Del|   |Web|Mut|VoU|VoD|   |PgU|PgD|Del|          |
 102     |-----------------------------------------------------------|
 103     |    |    |    |         FnS            |Fn  |    |    |    |
 104     `-----------------------------------------------------------'
 105
 106
 107
 108 ### 3. Funky keymap
 109 This is my keymap(default) with HHKB, Vi cursor and Mousekey layer.
 110
 111 See [keymap.h](keymap.h) for detail.
 112
 113 #### 3.0 Funky Default Layer
 114     ,-----------------------------------------------------------.
 115     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
 116     |-----------------------------------------------------------|
 117     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
 118     |-----------------------------------------------------------|
 119     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|*L3|  '|Return  |
 120     |-----------------------------------------------------------|
 121     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|*L2|Shift     |
 122     |-----------------------------------------------------------|
 123     |Ctrl|Gui |Alt |      Space             |Alt |*L3 |*L3 |*L1 |
 124     `-----------------------------------------------------------'
 125
 126 #### 3.1 Funky HHKB mode
 127     ,-----------------------------------------------------------.
 128     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
 129     |-----------------------------------------------------------|
 130     |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
 131     |-----------------------------------------------------------|
 132     |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 133     |-----------------------------------------------------------|
 134     |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
 135     |-----------------------------------------------------------|
 136     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |*L0 |
 137     `-----------------------------------------------------------'
 138
 139 #### 3.2 Funky Vi mode
 140     ,-----------------------------------------------------------.
 141     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 142     |-----------------------------------------------------------|
 143     |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
 144     |-----------------------------------------------------------|
 145     |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 146     |-----------------------------------------------------------|
 147     |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|*L0|Shift     |
 148     |-----------------------------------------------------------|
 149     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
 150     `-----------------------------------------------------------'
 151
 152 #### 3.3 Funky Mouse mode
 153     ,-----------------------------------------------------------.
 154     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 155     |-----------------------------------------------------------|
 156     |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
 157     |-----------------------------------------------------------|
 158     |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|*L0|   |Return  |
 159     |-----------------------------------------------------------|
 160     |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
 161     |-----------------------------------------------------------|
 162     |Ctrl|Gui |Alt |      Space             |Alt |*L0 |*L0 |Ctrl|
 163     `-----------------------------------------------------------'
 164     Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel