1
0
Fork 0
qmk_firmware/keyboard/gh60/README.md

113 lines
5.3 KiB
Markdown
Raw Normal View History

2012-12-27 07:06:13 +00:00
GH60 keyboard firmware
======================
DIY compact keyboard designed and run by komar007 and Geekhack community.
## Threads on Geekhack.org
- [Prototyping](http://geekhack.org/index.php?topic=34959.0)
- [Beta-test](http://geekhack.org/index.php?topic=37570.0)
## Build
Move to this directory then just run `make` like:
2013-11-21 07:32:45 +00:00
$ make
2013-02-11 04:56:05 +00:00
2013-11-21 07:32:45 +00:00
Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
2012-12-27 07:06:13 +00:00
## Keymap
2013-11-21 10:32:17 +00:00
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.
2012-12-27 07:06:13 +00:00
2013-11-21 10:32:17 +00:00
$ make KEYMAP=[poker|plain|poker_set|poker_bit|hasu|spacefn]
2013-02-12 08:08:51 +00:00
2013-02-11 04:56:05 +00:00
### 1. Plain keymap
2013-11-21 07:32:45 +00:00
Even without any Fn layer. This will be useful if you want to use key mapping tool like AHK.
2013-02-11 04:56:05 +00:00
2013-11-21 07:32:45 +00:00
See [keymap_plain.c](keymap_plain.c) for detail.
2013-02-11 04:56:05 +00:00
2013-02-12 08:08:51 +00:00
#### 1.0 Plain Default Layer
2013-02-11 04:56:05 +00:00
,-----------------------------------------------------------.
|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|
`-----------------------------------------------------------'
2013-02-12 08:08:51 +00:00
### 2 Poker keymap
2013-11-21 07:32:45 +00:00
[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:
2013-02-20 01:40:07 +00:00
2013-11-21 07:32:45 +00:00
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`.
2013-02-12 08:08:51 +00:00
#### 2.0 Poker Default Layer
,-----------------------------------------------------------.
| `| 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 |Fn |Gui |App |Ctrl|
`-----------------------------------------------------------'
#### 2.1 Poker Fn Layer
,-----------------------------------------------------------.
|Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12| |
|-----------------------------------------------------------|
| |FnQ| Up| | | | | | |Cal| |Hom|Ins| |
|-----------------------------------------------------------|
| |Lef|Dow|Rig| | |Psc|Slk|Pau| |Tsk|End| |
|-----------------------------------------------------------|
2013-11-21 07:32:45 +00:00
| |Del| |Web|Mut|VoU|VoD| |PgU|PgD|Del| Up |
2013-02-12 08:08:51 +00:00
|-----------------------------------------------------------|
2013-11-21 07:32:45 +00:00
| | | | FnS |Fn |Left|Down|Righ|
2013-02-12 08:08:51 +00:00
`-----------------------------------------------------------'
2013-02-11 04:56:05 +00:00
2013-11-21 07:32:45 +00:00
### 3. Hasu keymap
This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
2013-02-12 08:08:51 +00:00
2013-11-21 10:32:17 +00:00
### 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
2012-12-27 07:06:13 +00:00
,-----------------------------------------------------------.
|Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
|-----------------------------------------------------------|
|Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
|Caps | A| S| D| F| G| H| J| K| L| ;| '|Return |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
|Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
|Ctrl|Gui |Alt | Space/Fn |Alt |Gui |App |Ctrl|
2012-12-27 07:06:13 +00:00
`-----------------------------------------------------------'
2013-11-21 10:32:17 +00:00
#### 4.1 SpaceFN
2012-12-27 07:06:13 +00:00
,-----------------------------------------------------------.
2013-11-21 10:32:17 +00:00
|` | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
| | | | | | | |Hom|Up |End|Psc|Slk|Pau|Ins |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
| | | | | | |PgU|Lef|Dow|Rig| | | |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
| | | | | |Spc|PgD|` |~ | | | |
2012-12-27 07:06:13 +00:00
|-----------------------------------------------------------|
2013-11-21 10:32:17 +00:00
| | | | Fn | | | | |
2012-12-27 07:06:13 +00:00
`-----------------------------------------------------------'
2013-11-21 10:32:17 +00:00
2012-12-27 07:06:13 +00:00