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
  14
  15 Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
  16
  17
  18 ## Keymap
  19 Several version of keymap are available; `plain`, `poker_bit`, `poker_set`, `hasu` and `poker`(default). See keymap document(you can find in README.md of top) and `keymap_*.c` to define your own favourite keymap.
  20
  21     $ make KEYMAP=[poker|plain|poker_set|poker_bit|hasu]
  22
  23 ### 1. Plain keymap
  24 Even without any Fn layer. This will be useful if you want to use key mapping tool like AHK.
  25
  26 See [keymap_plain.c](keymap_plain.c) for detail.
  27
  28 #### 1.0 Plain Default Layer
  29     ,-----------------------------------------------------------.
  30     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  31     |-----------------------------------------------------------|
  32     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  33     |-----------------------------------------------------------|
  34     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  35     |-----------------------------------------------------------|
  36     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  37     |-----------------------------------------------------------|
  38     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
  39     `-----------------------------------------------------------'
  40
  41 ### 2  Poker keymap
  42
  43 [keymap_poker.c](keymap_poker.c) emulates original Poker layer emulation.
  44 [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) offers better support of Esc and arrow like:
  45
  46     Fn + Esc = `
  47     Fn + {left, down, up, right}  = {home, pgdown, pgup, end}
  48
  49  `poker` keymap supports Colemak, Dvorak and Workmans, use `Magic` + {`1`, `2`, `3`} to switch and `Magic` + `0` to return to Qwerty, where `Magic` is `LShift` + `RShift`.
  50
  51 #### 2.0 Poker Default Layer
  52     ,-----------------------------------------------------------.
  53     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  54     |-----------------------------------------------------------|
  55     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  56     |-----------------------------------------------------------|
  57     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  58     |-----------------------------------------------------------|
  59     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  60     |-----------------------------------------------------------|
  61     |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
  62     `-----------------------------------------------------------'
  63
  64 #### 2.1 Poker Fn Layer
  65     ,-----------------------------------------------------------.
  66     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
  67     |-----------------------------------------------------------|
  68     |     |FnQ| Up|   |   |   |   |   |   |Cal|   |Hom|Ins|     |
  69     |-----------------------------------------------------------|
  70     |      |Lef|Dow|Rig|   |   |Psc|Slk|Pau|   |Tsk|End|        |
  71     |-----------------------------------------------------------|
  72     |        |Del|   |Web|Mut|VoU|VoD|   |PgU|PgD|Del|   Up     |
  73     |-----------------------------------------------------------|
  74     |    |    |    |         FnS            |Fn  |Left|Down|Righ|
  75     `-----------------------------------------------------------'
  76
  77
  78
  79 ### 3. Hasu keymap
  80 This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
  81
  82 #### 3.0 Funky Default Layer
  83     ,-----------------------------------------------------------.
  84     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  85     |-----------------------------------------------------------|
  86     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  87     |-----------------------------------------------------------|
  88     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|*L3|  '|Return  |
  89     |-----------------------------------------------------------|
  90     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|*L2|Shift     |
  91     |-----------------------------------------------------------|
  92     |Ctrl|Gui |Alt |      Space             |Alt |*L3 |*L3 |*L1 |
  93     `-----------------------------------------------------------'
  94
  95 #### 3.1 Funky HHKB mode
  96     ,-----------------------------------------------------------.
  97     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
  98     |-----------------------------------------------------------|
  99     |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
 100     |-----------------------------------------------------------|
 101     |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 102     |-----------------------------------------------------------|
 103     |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
 104     |-----------------------------------------------------------|
 105     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |*L0 |
 106     `-----------------------------------------------------------'
 107
 108 #### 3.2 Funky Vi mode
 109     ,-----------------------------------------------------------.
 110     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 111     |-----------------------------------------------------------|
 112     |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
 113     |-----------------------------------------------------------|
 114     |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 115     |-----------------------------------------------------------|
 116     |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|*L0|Shift     |
 117     |-----------------------------------------------------------|
 118     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
 119     `-----------------------------------------------------------'
 120
 121 #### 3.3 Funky Mouse mode
 122     ,-----------------------------------------------------------.
 123     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 124     |-----------------------------------------------------------|
 125     |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
 126     |-----------------------------------------------------------|
 127     |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|*L0|   |Return  |
 128     |-----------------------------------------------------------|
 129     |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
 130     |-----------------------------------------------------------|
 131     |Ctrl|Gui |Alt |      Space             |Alt |*L0 |*L0 |Ctrl|
 132     `-----------------------------------------------------------'
 133     Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel