Add HHKB keymap file on gh60

author: tmk <nobody@nowhere> 2013-11-25 09:27:25 +0900
committer: tmk <nobody@nowhere> 2013-11-25 09:27:25 +0900
commit: 4e36159be226e544dfebbe06b1955261951209a4 (patch)
tree: 2625d57942d556daaa49e09ba3d4211e1e9ef103 /keyboard/gh60/README.md
parent: beacd5872c525b4bad215d2b2a4ff9ec60518e2f (diff)
download: qmk_firmware-4e36159be226e544dfebbe06b1955261951209a4.tar.gz
qmk_firmware-4e36159be226e544dfebbe06b1955261951209a4.zip
1 files changed, 66 insertions, 37 deletions
diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md
index 07ed40d8e..5e0fc244f 100644
--- a/keyboard/gh60/README.md
+++ b/keyboard/gh60/README.md
@@ -2,9 +2,14 @@ GH60 keyboard firmware
 ======================
 DIY compact keyboard designed and run by komar007 and Geekhack community.
-## Threads on Geekhack.org
+- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)
+## GH60 Resources
+- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)
 - [Prototyping](http://geekhack.org/index.php?topic=34959.0)
- [Beta-test](http://geekhack.org/index.php?topic=37570.0)
+- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)
+- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)
+- [Group buy](http://geekhack.org/index.php?topic=41464.0)
 ## Build
@@ -16,39 +21,21 @@ Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason t
 ## Keymap
-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.
+Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
-    $ make KEYMAP=[poker|plain|poker_set|poker_bit|hasu|spacefn]
+To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
-### 1. Plain keymap
+    $ make KEYMAP=[poker|poker_set|poker_bit|plain|hasu|spacefn|hhkb|<name>]
-Even without any Fn layer. This will be useful if you want to use key mapping tool like AHK.
-See [keymap_plain.c](keymap_plain.c) for detail.
-#### 1.0 Plain Default Layer
+### 1  Poker
-    ,-----------------------------------------------------------.
+[keymap_poker.c](keymap_poker.c) emulates original Poker layers
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
+while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
-    `-----------------------------------------------------------'
-### 2  Poker keymap
-[keymap_poker.c](keymap_poker.c) emulates original Poker layer emulation.
-[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:
    Fn + Esc = `
    Fn + {left, down, up, right}  = {home, pgdown, pgup, end}
- `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`.
+#### 1.0 Default layer
-#### 2.0 Poker Default Layer
    ,-----------------------------------------------------------.
    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
    |-----------------------------------------------------------|
@@ -60,8 +47,7 @@ See [keymap_plain.c](keymap_plain.c) for detail.
    |-----------------------------------------------------------|
    |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
    `-----------------------------------------------------------'
+#### 1.1 Poker Fn layer
-#### 2.1 Poker Fn Layer
    ,-----------------------------------------------------------.
    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
    |-----------------------------------------------------------|
@@ -75,14 +61,32 @@ See [keymap_plain.c](keymap_plain.c) for detail.
    `-----------------------------------------------------------'
-### 3. Hasu keymap
+### 2. Plain
-This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
+Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
+See [keymap_plain.c](keymap_plain.c) for detail.
+#### 1.0 Plain Default layer
+    ,-----------------------------------------------------------.
+    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
+    |-----------------------------------------------------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
+    |-----------------------------------------------------------|
+    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
+    |-----------------------------------------------------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
+    |-----------------------------------------------------------|
+    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
+    `-----------------------------------------------------------'
-### 4. SpaceFN keymap
-See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
-#### 4.0 SpaceFN Default Layer
+### 3. Hasu
+This is my favourite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
+### 4. SpaceFN
+This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
+#### 4.0 Default layer
    ,-----------------------------------------------------------.
    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
    |-----------------------------------------------------------|
@@ -94,8 +98,7 @@ See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhac
    |-----------------------------------------------------------|
    |Ctrl|Gui |Alt |      Space/Fn          |Alt |Gui |App |Ctrl|
    `-----------------------------------------------------------'
-    
+#### 4.1 SpaceFN layer
-#### 4.1 SpaceFN
    ,-----------------------------------------------------------.
    |`  | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
    |-----------------------------------------------------------|
@@ -107,6 +110,32 @@ See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhac
    |-----------------------------------------------------------|
    |    |    |    |            Fn          |    |    |    |    |
    `-----------------------------------------------------------'
-    
+### 5. HHKB
+[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.
+#### 5.0: Default layer
+    ,-----------------------------------------------------------.
+    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
+    |-----------------------------------------------------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Bspc |
+    |-----------------------------------------------------------|
+    |Ctrl  |  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
+    |-----------------------------------------------------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn |
+    |-----------------------------------------------------------|
+    |    |Gui |Alt |      Space             |    |Alt |Gui |    |
+    `-----------------------------------------------------------'
+#### 5.1: HHKB Fn layer
+    ,-----------------------------------------------------------.
+    |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
+    |-----------------------------------------------------------|
+    |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |     |
+    |-----------------------------------------------------------|
+    |      |VoD|VoU|Mut|Ejc|   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
+    |-----------------------------------------------------------|
+    |        |   |   |   |   |   |  +|  -|End|PgD|Dow|      |   |
+    |-----------------------------------------------------------|
+    |    |    |    |                        |    |    |    |    |
+    `-----------------------------------------------------------'
author	tmk <nobody@nowhere>	2013-11-25 09:27:25 +0900
committer	tmk <nobody@nowhere>	2013-11-25 09:27:25 +0900
commit	4e36159be226e544dfebbe06b1955261951209a4 (patch)
tree	2625d57942d556daaa49e09ba3d4211e1e9ef103 /keyboard/gh60/README.md
parent	beacd5872c525b4bad215d2b2a4ff9ec60518e2f (diff)
download	qmk_firmware-4e36159be226e544dfebbe06b1955261951209a4.tar.gz qmk_firmware-4e36159be226e544dfebbe06b1955261951209a4.zip

diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md index 07ed40d8e..5e0fc244f 100644 --- a/keyboard/gh60/README.md +++ b/keyboard/gh60/README.md
@@ -2,9 +2,14 @@ GH60 keyboard firmware
2	======================	2	======================
3	DIY compact keyboard designed and run by komar007 and Geekhack community.	3	DIY compact keyboard designed and run by komar007 and Geekhack community.
4		4
5	## Threads on Geekhack.org	5	- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)
		6
		7	## GH60 Resources
		8	- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)
6	- [Prototyping](http://geekhack.org/index.php?topic=34959.0)	9	- [Prototyping](http://geekhack.org/index.php?topic=34959.0)
7	- [Beta-test](http://geekhack.org/index.php?topic=37570.0)	10	- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)
		11	- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)
		12	- [Group buy](http://geekhack.org/index.php?topic=41464.0)
8		13
9		14
10	## Build	15	## Build
@@ -16,39 +21,21 @@ Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason t
16		21
17		22
18	## Keymap	23	## 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.	24	Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
20		25
21	$ make KEYMAP=[poker\|plain\|poker_set\|poker_bit\|hasu\|spacefn]	26	To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
22		27
23	### 1. Plain keymap	28	$ make KEYMAP=[poker\|poker_set\|poker_bit\|plain\|hasu\|spacefn\|hhkb\|<name>]
24	Even without any Fn layer. This will be useful if you want to use key mapping tool like AHK.
25		29
26	See [keymap_plain.c](keymap_plain.c) for detail.
27		30
28	#### 1.0 Plain Default Layer	31	### 1 Poker
29	,-----------------------------------------------------------.	32	[keymap_poker.c](keymap_poker.c) emulates original Poker layers
30	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|	33	while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
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		34
46	Fn + Esc = `	35	Fn + Esc = `
47	Fn + {left, down, up, right} = {home, pgdown, pgup, end}	36	Fn + {left, down, up, right} = {home, pgdown, pgup, end}
48		37
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`.	38	#### 1.0 Default layer
50
51	#### 2.0 Poker Default Layer
52	,-----------------------------------------------------------.	39	,-----------------------------------------------------------.
53	\| `\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|	40	\| `\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
54	\|-----------------------------------------------------------\|	41	\|-----------------------------------------------------------\|
@@ -60,8 +47,7 @@ See [keymap_plain.c](keymap_plain.c) for detail.
60	\|-----------------------------------------------------------\|	47	\|-----------------------------------------------------------\|
61	\|Ctrl\|Gui \|Alt \| Space \|Fn \|Gui \|App \|Ctrl\|	48	\|Ctrl\|Gui \|Alt \| Space \|Fn \|Gui \|App \|Ctrl\|
62	`-----------------------------------------------------------'	49	`-----------------------------------------------------------'
63		50	#### 1.1 Poker Fn layer
64	#### 2.1 Poker Fn Layer
65	,-----------------------------------------------------------.	51	,-----------------------------------------------------------.
66	\|Esc\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\| \|	52	\|Esc\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\| \|
67	\|-----------------------------------------------------------\|	53	\|-----------------------------------------------------------\|
@@ -75,14 +61,32 @@ See [keymap_plain.c](keymap_plain.c) for detail.
75	`-----------------------------------------------------------'	61	`-----------------------------------------------------------'
76		62
77		63
78	### 3. Hasu keymap	64	### 2. Plain
79	This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.	65	Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
		66	See [keymap_plain.c](keymap_plain.c) for detail.
80		67
		68	#### 1.0 Plain Default layer
		69	,-----------------------------------------------------------.
		70	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
		71	\|-----------------------------------------------------------\|
		72	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|
		73	\|-----------------------------------------------------------\|
		74	\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|
		75	\|-----------------------------------------------------------\|
		76	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|
		77	\|-----------------------------------------------------------\|
		78	\|Ctrl\|Gui \|Alt \| Space \|Alt \|Gui \|App \|Ctrl\|
		79	`-----------------------------------------------------------'
81		80
82	### 4. SpaceFN keymap
83	See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
84		81
85	#### 4.0 SpaceFN Default Layer	82	### 3. Hasu
		83	This is my favourite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
		84
		85
		86	### 4. SpaceFN
		87	This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
		88
		89	#### 4.0 Default layer
86	,-----------------------------------------------------------.	90	,-----------------------------------------------------------.
87	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|	91	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
88	\|-----------------------------------------------------------\|	92	\|-----------------------------------------------------------\|
@@ -94,8 +98,7 @@ See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhac
94	\|-----------------------------------------------------------\|	98	\|-----------------------------------------------------------\|
95	\|Ctrl\|Gui \|Alt \| Space/Fn \|Alt \|Gui \|App \|Ctrl\|	99	\|Ctrl\|Gui \|Alt \| Space/Fn \|Alt \|Gui \|App \|Ctrl\|
96	`-----------------------------------------------------------'	100	`-----------------------------------------------------------'
97		101	#### 4.1 SpaceFN layer
98	#### 4.1 SpaceFN
99	,-----------------------------------------------------------.	102	,-----------------------------------------------------------.
100	\|` \| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Delete \|	103	\|` \| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Delete \|
101	\|-----------------------------------------------------------\|	104	\|-----------------------------------------------------------\|
@@ -107,6 +110,32 @@ See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhac
107	\|-----------------------------------------------------------\|	110	\|-----------------------------------------------------------\|
108	\| \| \| \| Fn \| \| \| \| \|	111	\| \| \| \| Fn \| \| \| \| \|
109	`-----------------------------------------------------------'	112	`-----------------------------------------------------------'
110
111		113
112		114
		115	### 5. HHKB
		116	[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.
		117	#### 5.0: Default layer
		118	,-----------------------------------------------------------.
		119	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\| \\| `\|
		120	\|-----------------------------------------------------------\|
		121	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\|Bspc \|
		122	\|-----------------------------------------------------------\|
		123	\|Ctrl \| A\| S\| D\| F\| G\| H\| J\| K\| L\|Fn3\| '\|Return \|
		124	\|-----------------------------------------------------------\|
		125	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|Fn \|
		126	\|-----------------------------------------------------------\|
		127	\| \|Gui \|Alt \| Space \| \|Alt \|Gui \| \|
		128	`-----------------------------------------------------------'
		129	#### 5.1: HHKB Fn layer
		130	,-----------------------------------------------------------.
		131	\|Pwr\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Ins\|Del\|
		132	\|-----------------------------------------------------------\|
		133	\|Caps \| \| \| \| \| \| \| \|Psc\|Slk\|Pus\|Up \| \| \|
		134	\|-----------------------------------------------------------\|
		135	\| \|VoD\|VoU\|Mut\|Ejc\| \| *\| /\|Hom\|PgU\|Lef\|Rig\|Enter \|
		136	\|-----------------------------------------------------------\|
		137	\| \| \| \| \| \| \| +\| -\|End\|PgD\|Dow\| \| \|
		138	\|-----------------------------------------------------------\|
		139	\| \| \| \| \| \| \| \| \|
		140	`-----------------------------------------------------------'
		141