## Build
Move to this directory then just run `make` like:
- $ make -f Makfile.pjrc
+ $ make -f Makfile.[pjrc|lufa]
+
+Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
+
+
+## Boot Magic
+Plugin pressing these `Boot Magic` key.
+
+- `Fn` key for bootloader kick up.
+- `D` key for Debug enable.
## Keymap
+Two version of keymap are available. `Plan`, `Poker` and `Funky`(default).
See keymap.c to define your own favourite keymap.
-###Keymap with funky layers.
- Layer 0: Default Layer
+ $ make -f Makefile.[pjrc|lufa] [plain|poker]
+
+### 1. Plain keymap
+This will be useful if you want to use key mapping tool like AHK.
+
+See [keymap_plain.h](keymap_plain.h) 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|Fn3| '|Return |
+ |Caps | A| S| D| F| G| H| J| K| L| ;| '|Return |
|-----------------------------------------------------------|
- |Shift | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |
+ |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |App |Fn1 |
+ |Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
`-----------------------------------------------------------'
- Layer 1: HHKB mode
+### 2 Poker keymap
+
+See [keymap_poker.h](keymap_poker.h) for Poker layer emulation, [keymap_poker_bit.h](keymap_poker_bit.h) and [keymap_poker_set.h](keymap_poker_set.h) for better support of Esc and arrow.
+
+ These keymap supports Colemak, Dvorak and Workmans, use `Magic` + {`1`, `2`, `3`} to switch and `Magic` + `0` to return to Qwerty.
+
+#### 2.0 Poker Default Layer
,-----------------------------------------------------------.
- |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
+ | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
|-----------------------------------------------------------|
- |Caps | | | | | | | |Psc|Slk|Pus|Up | |Inser|
+ |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
|-----------------------------------------------------------|
- |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
+ |Caps | A| S| D| F| G| H| J| K| L| ;| '|Return |
|-----------------------------------------------------------|
- |Shift | | | | | | +| -|End|PgD|Dow|Shift |
+ |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |App |xxx |
+ |Ctrl|Gui |Alt | Space |Fn |Gui |App |Ctrl|
`-----------------------------------------------------------'
- Layer 2: Vi mode
+#### 2.1 Poker Arrow Layer
,-----------------------------------------------------------.
- | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
+ | | | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End| | | | |
+ | | | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
+ | | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Shift | | | | | |Hom|PgD|PgU|End|xxx|Shift |
+ | | | | | | | | | | | | Up |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
+ | | | | |Fn |Left|Down|Righ|
`-----------------------------------------------------------'
- Layer 3: Mouse mode
+#### 2.2 Poker Esc Layer
,-----------------------------------------------------------.
- | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
+ |Esc| | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Tab |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR| | | | |
+ | | | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Contro| |McL|McD|McR| |McL|McD|McU|McR|xxx| |Return |
+ | | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Shift | | |Mb1|Mb2|Mb3|Mb2|Mb1| | | |Shift |
+ | | | | | | | | | | | | |
|-----------------------------------------------------------|
- |Ctrl|Gui |Alt | Space |Alt |Gui |xxx |Ctrl|
+ | | | | |Fn | | | |
+ `-----------------------------------------------------------'
+
+#### 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| |
+ |-----------------------------------------------------------|
+ | |Del| |Web|Mut|VoU|VoD| |PgU|PgD|Del| |
+ |-----------------------------------------------------------|
+ | | | | FnS |Fn | | | |
`-----------------------------------------------------------'
- 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
+### 3. Funky keymap
+This is my keymap(default) with HHKB, Vi cursor and Mousekey layer.
+
+See [keymap.c](keymap.c) for detail.
+
+#### 3.0 Funky 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 |
+ |Caps | A| S| D| F| G| H| J| K| L|*L3| '|Return |
|-----------------------------------------------------------|
- |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
+ |Shift | Z| X| C| V| B| N| M| ,| .|*L2|Shift |
+ |-----------------------------------------------------------|
+ |Ctrl|Gui |Alt | Space |Alt |*L3 |*L3 |*L1 |
+ `-----------------------------------------------------------'
+
+#### 3.1 Funky HHKB mode
+ ,-----------------------------------------------------------.
+ |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
+ |-----------------------------------------------------------|
+ |Caps | | | | | | | |Psc|Slk|Pus|Up | |Inser|
+ |-----------------------------------------------------------|
+ |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
+ |-----------------------------------------------------------|
+ |Shift | | | | | | +| -|End|PgD|Dow|Shift |
+ |-----------------------------------------------------------|
+ |Ctrl|Gui |Alt | Space |Alt |Gui |App |*L0 |
+ `-----------------------------------------------------------'
+
+#### 3.2 Funky Vi mode
+ ,-----------------------------------------------------------.
+ | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
+ |-----------------------------------------------------------|
+ |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End| | | | |
+ |-----------------------------------------------------------|
+ |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
+ |-----------------------------------------------------------|
+ |Shift | | | | | |Hom|PgD|PgU|End|*L0|Shift |
|-----------------------------------------------------------|
|Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
`-----------------------------------------------------------'
+
+#### 3.3 Funky 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|*L0| |Return |
+ |-----------------------------------------------------------|
+ |Shift | | |Mb1|Mb2|Mb3|Mb2|Mb1| | | |Shift |
+ |-----------------------------------------------------------|
+ |Ctrl|Gui |Alt | Space |Alt |*L0 |*L0 |Ctrl|
+ `-----------------------------------------------------------'
+ Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
projects / max / tmk_keyboard.git / blobdiff