summaryrefslogtreecommitdiffstats
path: root/keyboard/gh60/README.md
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2013-02-11 05:56:05 +0100
committertmk <nobody@nowhere>2013-02-11 06:14:44 +0100
commitb60f9c6ac6fa9f63cba7ffb6872095a8f0788e42 (patch)
treeafb7e6a962220c5cf0e60713489c9ae86251cfe4 /keyboard/gh60/README.md
parent8c80deb775ac151001dc1592a2e94e8677b49964 (diff)
downloadqmk_firmware-b60f9c6ac6fa9f63cba7ffb6872095a8f0788e42.tar.gz
qmk_firmware-b60f9c6ac6fa9f63cba7ffb6872095a8f0788e42.tar.xz
Boot Magic key for gh60
Diffstat (limited to 'keyboard/gh60/README.md')
-rw-r--r--keyboard/gh60/README.md72
1 files changed, 42 insertions, 30 deletions
diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md
index 73eb4b6d5..289467aba 100644
--- a/keyboard/gh60/README.md
+++ b/keyboard/gh60/README.md
@@ -10,27 +10,56 @@ DIY compact keyboard designed and run by komar007 and Geekhack community.
## Build
Move to this directory then just run `make` like:
- $ make -f Makfile.pjrc
+ $ make -f Makfile.[pjrc|lufa]
+
+
+## Boot Magic
+- `Fn` key for bootloader kick up.
+- `D` key for Debug enable.
## Keymap
+Two version of keymap are available. `Plan` and `Funky`.
See keymap.c to define your own favourite keymap.
-###Keymap with funky layers.
- Layer 0: Default Layer
+### 1. Plain keymap
+This will be useful if you want to use key mapping tool like AHK.
+To get this plain keymap do `make`:
+
+ $ make -f Makefile.[pjrc|lufa] plain
+
+### Layer 0
+ ,-----------------------------------------------------------.
+ |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|
+ `-----------------------------------------------------------'
+
+
+### 2. Funky layers.
+
+ $ make -f Makefile.[pjrc|lufa]
+
+#### Layer 0: 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|Fn3| '|Return |
+ |Caps | A| S| D| F| G| H| J| K| L|*L3| '|Return |
|-----------------------------------------------------------|
- |Shift | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |
+ |Shift | Z| X| C| V| B| N| M| ,| .|*L2|Shift |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |App |Fn1 |
+ |Ctrl|Gui |Alt | Space |Alt |*L3 |*L3 |*L1 |
`-----------------------------------------------------------'
- Layer 1: HHKB mode
+#### Layer 1: HHKB mode
,-----------------------------------------------------------.
|Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
|-----------------------------------------------------------|
@@ -40,10 +69,10 @@ See keymap.c to define your own favourite keymap.
|-----------------------------------------------------------|
|Shift | | | | | | +| -|End|PgD|Dow|Shift |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |App |xxx |
+ |Ctrl|Gui |Alt | Space |Alt |Gui |App |*L0 |
`-----------------------------------------------------------'
- Layer 2: Vi mode
+#### Layer 2: Vi mode
,-----------------------------------------------------------.
| `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
|-----------------------------------------------------------|
@@ -51,39 +80,22 @@ See keymap.c to define your own favourite keymap.
|-----------------------------------------------------------|
|Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
|-----------------------------------------------------------|
- |Shift | | | | | |Hom|PgD|PgU|End|xxx|Shift |
+ |Shift | | | | | |Hom|PgD|PgU|End|*L0|Shift |
|-----------------------------------------------------------|
|Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
`-----------------------------------------------------------'
- Layer 3: Mouse mode
+#### Layer 3: Mouse mode
,-----------------------------------------------------------.
| `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
|-----------------------------------------------------------|
|Tab |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR| | | | |
|-----------------------------------------------------------|
- |Contro| |McL|McD|McR| |McL|McD|McU|McR|xxx| |Return |
+ |Contro| |McL|McD|McR| |McL|McD|McU|McR|*L0| |Return |
|-----------------------------------------------------------|
|Shift | | |Mb1|Mb2|Mb3|Mb2|Mb1| | | |Shift |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |xxx |Ctrl|
+ |Ctrl|Gui |Alt | Space |Alt |*L0 |*L0 |Ctrl|
`-----------------------------------------------------------'
Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
-### Plain keymap without Fn layer.
-This will be useful if you want to use key mapping tool like AHK.
-To get this plain keymap run:
-
- $ make -f Makefile.pjrc plain
-
- ,-----------------------------------------------------------.
- |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|
- `-----------------------------------------------------------'