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
  16 ## Boot Magic
  17 - `Fn` key for bootloader kick up.
  18 - `D` key for Debug enable.
  19
  20
  21 ## Keymap
  22 Two version of keymap are available. `Plan` and `Funky`.
  23 See keymap.c to define your own favourite keymap.
  24
  25 ### 1. Plain keymap
  26 This will be useful if you want to use key mapping tool like AHK.
  27 To get this plain keymap do `make`:
  28
  29     $ make -f Makefile.[pjrc|lufa] plain
  30
  31 ### Layer 0
  32     ,-----------------------------------------------------------.
  33     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  34     |-----------------------------------------------------------|
  35     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  36     |-----------------------------------------------------------|
  37     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  38     |-----------------------------------------------------------|
  39     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
  40     |-----------------------------------------------------------|
  41     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
  42     `-----------------------------------------------------------'
  43
  44
  45 ### 2. Funky layers.
  46
  47     $ make -f Makefile.[pjrc|lufa]
  48
  49 #### Layer 0: Default Layer
  50     ,-----------------------------------------------------------.
  51     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  52     |-----------------------------------------------------------|
  53     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  54     |-----------------------------------------------------------|
  55     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|*L3|  '|Return  |
  56     |-----------------------------------------------------------|
  57     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|*L2|Shift     |
  58     |-----------------------------------------------------------|
  59     |Ctrl|Gui |Alt |      Space             |Alt |*L3 |*L3 |*L1 |
  60     `-----------------------------------------------------------'
  61
  62 #### Layer 1: HHKB mode
  63     ,-----------------------------------------------------------.
  64     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
  65     |-----------------------------------------------------------|
  66     |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
  67     |-----------------------------------------------------------|
  68     |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  69     |-----------------------------------------------------------|
  70     |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
  71     |-----------------------------------------------------------|
  72     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |*L0 |
  73     `-----------------------------------------------------------'
  74
  75 #### Layer 2: Vi mode
  76     ,-----------------------------------------------------------.
  77     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  78     |-----------------------------------------------------------|
  79     |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
  80     |-----------------------------------------------------------|
  81     |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
  82     |-----------------------------------------------------------|
  83     |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|*L0|Shift     |
  84     |-----------------------------------------------------------|
  85     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
  86     `-----------------------------------------------------------'
  87
  88 #### Layer 3: Mouse mode
  89     ,-----------------------------------------------------------.
  90     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  91     |-----------------------------------------------------------|
  92     |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
  93     |-----------------------------------------------------------|
  94     |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|*L0|   |Return  |
  95     |-----------------------------------------------------------|
  96     |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
  97     |-----------------------------------------------------------|
  98     |Ctrl|Gui |Alt |      Space             |Alt |*L0 |*L0 |Ctrl|
  99     `-----------------------------------------------------------'
 100     Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 101