]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/gh60/README.md
Add README and keymap layers.(GH60)
[qmk_firmware.git] / 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
14
15
16 ## Keymap
17 See keymap.c to define your own favourite keymap.
18
19 ###Keymap with funky layers.
20     Layer 0: Default Layer
21     ,-----------------------------------------------------------.
22     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
23     |-----------------------------------------------------------|
24     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
25     |-----------------------------------------------------------|
26     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
27     |-----------------------------------------------------------|
28     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|Fn2|Shift     |
29     |-----------------------------------------------------------|
30     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Fn1 |
31     `-----------------------------------------------------------'
32
33     Layer 1: HHKB mode
34     ,-----------------------------------------------------------.
35     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
36     |-----------------------------------------------------------|
37     |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
38     |-----------------------------------------------------------|
39     |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
40     |-----------------------------------------------------------|
41     |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
42     |-----------------------------------------------------------|
43     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |xxx |
44     `-----------------------------------------------------------'
45
46     Layer 2: Vi mode
47     ,-----------------------------------------------------------.
48     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
49     |-----------------------------------------------------------|
50     |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
51     |-----------------------------------------------------------|
52     |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
53     |-----------------------------------------------------------|
54     |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|xxx|Shift     |
55     |-----------------------------------------------------------|
56     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
57     `-----------------------------------------------------------'
58
59     Layer 3: Mouse mode
60     ,-----------------------------------------------------------.
61     |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
62     |-----------------------------------------------------------|
63     |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
64     |-----------------------------------------------------------|
65     |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|xxx|   |Return  |
66     |-----------------------------------------------------------|
67     |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
68     |-----------------------------------------------------------|
69     |Ctrl|Gui |Alt |      Space             |Alt |Gui |xxx |Ctrl|
70     `-----------------------------------------------------------'
71     Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel 
72
73 ### Plain keymap without Fn layer.
74 This will be useful if you want to use key mapping tool like AHK.
75 To get this plain keymap run:
76
77     $ make -f Makefile.pjrc plain
78
79     ,-----------------------------------------------------------.
80     |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
81     |-----------------------------------------------------------|
82     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
83     |-----------------------------------------------------------|
84     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
85     |-----------------------------------------------------------|
86     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
87     |-----------------------------------------------------------|
88     |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
89     `-----------------------------------------------------------'