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`, `spacefn`  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|spacefn]
  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 ### 3. Hasu keymap
  79 This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
  80
  81
  82 ### 4. SpaceFN keymap
  83 See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
  84
  85 #### 4.0 SpaceFN Default Layer
  86     ,-----------------------------------------------------------.
  87     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  88     |-----------------------------------------------------------|
  89     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  90     |-----------------------------------------------------------|
  91     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  92     |-----------------------------------------------------------|
  93     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  94     |-----------------------------------------------------------|
  95     |Ctrl|Gui |Alt |      Space/Fn          |Alt |Gui |App |Ctrl|
  96     `-----------------------------------------------------------'
  97
  98 #### 4.1 SpaceFN
  99     ,-----------------------------------------------------------.
 100     |`  | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
 101     |-----------------------------------------------------------|
 102     |     |   |   |   |   |   |   |Hom|Up |End|Psc|Slk|Pau|Ins  |
 103     |-----------------------------------------------------------|
 104     |      |   |   |   |   |   |PgU|Lef|Dow|Rig|   |   |        |
 105     |-----------------------------------------------------------|
 106     |        |   |   |   |   |Spc|PgD|`  |~  |   |   |          |
 107     |-----------------------------------------------------------|
 108     |    |    |    |            Fn          |    |    |    |    |
 109     `-----------------------------------------------------------'
 110
 111
 112