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
  51 See [keymap_poker.h](keymap_poker.h) for Poker layer emulation, [keymap_poker_bit.h](keymap_poker_bit.h) and [keymap_poker_set.h](keymap_poker_set.h) for better support of Esc and arrow.
  52
  53  These keymap supports Colemak, Dvorak and Workmans, use `Magic` + {`1`, `2`, `3`} to switch and `Magic` + `0` to return to Qwerty.
  54
  55 #### 2.0 Poker Default Layer
  56     ,-----------------------------------------------------------.
  57     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  58     |-----------------------------------------------------------|
  59     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  60     |-----------------------------------------------------------|
  61     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  62     |-----------------------------------------------------------|
  63     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  64     |-----------------------------------------------------------|
  65     |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
  66     `-----------------------------------------------------------'
  67
  68 #### 2.1 Poker Arrow Layer
  69     ,-----------------------------------------------------------.
  70     |   |   |   |   |   |   |   |   |   |   |   |   |   |       |
  71     |-----------------------------------------------------------|
  72     |     |   |   |   |   |   |   |   |   |   |   |   |   |     |
  73     |-----------------------------------------------------------|
  74     |      |   |   |   |   |   |   |   |   |   |   |   |        |
  75     |-----------------------------------------------------------|
  76     |        |   |   |   |   |   |   |   |   |   |   |  Up      |
  77     |-----------------------------------------------------------|
  78     |    |    |    |                        |Fn  |Left|Down|Righ|
  79     `-----------------------------------------------------------'
  80
  81 #### 2.2 Poker Esc Layer
  82     ,-----------------------------------------------------------.
  83     |Esc|   |   |   |   |   |   |   |   |   |   |   |   |       |
  84     |-----------------------------------------------------------|
  85     |     |   |   |   |   |   |   |   |   |   |   |   |   |     |
  86     |-----------------------------------------------------------|
  87     |      |   |   |   |   |   |   |   |   |   |   |   |        |
  88     |-----------------------------------------------------------|
  89     |        |   |   |   |   |   |   |   |   |   |   |          |
  90     |-----------------------------------------------------------|
  91     |    |    |    |                        |Fn  |    |    |    |
  92     `-----------------------------------------------------------'
  93
  94 #### 2.1 Poker Fn Layer
  95     ,-----------------------------------------------------------.
  96     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
  97     |-----------------------------------------------------------|
  98     |     |FnQ| Up|   |   |   |   |   |   |Cal|   |Hom|Ins|     |
  99     |-----------------------------------------------------------|
 100     |      |Lef|Dow|Rig|   |   |Psc|Slk|Pau|   |Tsk|End|        |
 101     |-----------------------------------------------------------|
 102     |        |Del|   |Web|Mut|VoU|VoD|   |PgU|PgD|Del|          |
 103     |-----------------------------------------------------------|
 104     |    |    |    |         FnS            |Fn  |    |    |    |
 105     `-----------------------------------------------------------'
 106
 107
 108
 109 ### 3. Funky keymap
 110 This is my keymap(default) with HHKB, Vi cursor and Mousekey layer.
 111
 112 See [keymap.c](keymap.c) for detail.
 113
 114 #### 3.0 Funky Default Layer
 115     ,-----------------------------------------------------------.
 116     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
 117     |-----------------------------------------------------------|
 118     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
 119     |-----------------------------------------------------------|
 120     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|*L3|  '|Return  |
 121     |-----------------------------------------------------------|
 122     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|*L2|Shift     |
 123     |-----------------------------------------------------------|
 124     |Ctrl|Gui |Alt |      Space             |Alt |*L3 |*L3 |*L1 |
 125     `-----------------------------------------------------------'
 126
 127 #### 3.1 Funky HHKB mode
 128     ,-----------------------------------------------------------.
 129     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
 130     |-----------------------------------------------------------|
 131     |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
 132     |-----------------------------------------------------------|
 133     |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 134     |-----------------------------------------------------------|
 135     |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
 136     |-----------------------------------------------------------|
 137     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |*L0 |
 138     `-----------------------------------------------------------'
 139
 140 #### 3.2 Funky Vi mode
 141     ,-----------------------------------------------------------.
 142     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 143     |-----------------------------------------------------------|
 144     |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
 145     |-----------------------------------------------------------|
 146     |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 147     |-----------------------------------------------------------|
 148     |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|*L0|Shift     |
 149     |-----------------------------------------------------------|
 150     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
 151     `-----------------------------------------------------------'
 152
 153 #### 3.3 Funky Mouse mode
 154     ,-----------------------------------------------------------.
 155     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 156     |-----------------------------------------------------------|
 157     |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
 158     |-----------------------------------------------------------|
 159     |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|*L0|   |Return  |
 160     |-----------------------------------------------------------|
 161     |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
 162     |-----------------------------------------------------------|
 163     |Ctrl|Gui |Alt |      Space             |Alt |*L0 |*L0 |Ctrl|
 164     `-----------------------------------------------------------'
 165     Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel