yohan/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Lightsaber read me

Browse Source
This commit is contained in:
Ralf Schmitt 2014-03-19 00:21:45 +01:00
parent 5ca3bde10a
commit 160678a7b8
1 changed files with 4 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
keyboard/lightsaber/README.md
View File

@ -1,12 +1,12 @@
KMAC keyboard firmware Lightsaber keyboard firmware
====================== ======================
Korean custom keyboard designed by Byungho Kim and KBDMania community. Korean custom keyboard designed by Duck.
*Note that this is not the official firmware* *Note that this is not the official firmware*
Supported models Supported models
---------------- ----------------
At the moment only the TKL models is supported. All pcb options are supported.
Build Build
@ -20,91 +20,7 @@ Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUF
Bootloader Bootloader
--------- ---------
The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard. The PCB is hardwired to run the bootloader if the key at the `one above backspace` position is held down when connecting the keyboard.
It is still possible to use Boot Magic and Command to access the bootloader though. It is still possible to use Boot Magic and Command to access the bootloader though.
Keymap
------
There are 2 different types of PCB.
They each have their own keymap file.
To customize a keymap:
1. Edit the file that corresponds to your PCB.
2. Specify your layout when building.
### 1. Winkey
This is the default keymap.
See [keymap_winkey.h](keymap_winkey.h) for detail.
#### 1.0. Winkey Default Layer
,---. ,---------------. ,---------------. ,---------------. ,-----------.
|Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
`---' `---------------' `---------------' `---------------' `-----------'
,-----------------------------------------------------------. ,-----------.
|~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
|-----------------------------------------------------------| |-----------|
|Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
|-----------------------------------------------------------| '-----------'
|Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
|-----------------------------------------------------------| ,---.
|Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
|-----------------------------------------------------------| ,-----------.
|Ctl|Gui|Alt| Space |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
`-----------------------------------------------------------' `-----------'
#### 1.1. Winkey Media Layer
,---. ,---------------. ,---------------. ,---------------. ,-----------.
|Led| | | | | | | | | | | | | | | | | | |Slp|
`---' `---------------' `---------------' `---------------' `-----------'
,-----------------------------------------------------------. ,-----------.
| | | | | | | | | | |Mut|V- |V+ | | | | | |
|-----------------------------------------------------------| |-----------|
| | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
|-----------------------------------------------------------| '-----------'
| | | | | | | | | | | | | |
|-----------------------------------------------------------| ,---.
| | | |Clc| | | | | | | |Caps | | |
|-----------------------------------------------------------| ,-----------.
| | | | | | | | | | | | |
`-----------------------------------------------------------' `-----------'
### 2. Winkeyless
Layout with 1.5 unit modifiers.
See [keymap_winkeyless.h](keymap_winkeyless.h) for detail.
#### 2.0. Winkeyless Default Layer
,---. ,---------------. ,---------------. ,---------------. ,-----------.
|Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
`---' `---------------' `---------------' `---------------' `-----------'
,-----------------------------------------------------------. ,-----------.
|~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
|-----------------------------------------------------------| |-----------|
|Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
|-----------------------------------------------------------| '-----------'
|Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
|-----------------------------------------------------------| ,---.
|Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
|-----------------------------------------------------------| ,-----------.
|Ctl |Gui|Alt | Space |Alt |Gui|Ctl | |Lef|Dow|Rig|
`-----------------------------------------------------------' `-----------'
#### 2.1. Winkeyless Media Layer
,---. ,---------------. ,---------------. ,---------------. ,-----------.
|Led| | | | | | | | | | | | | | | | | | |Slp|
`---' `---------------' `---------------' `---------------' `-----------'
,-----------------------------------------------------------. ,-----------.
| | | | | | | | | | |Mut|V- |V+ | | | | | |
|-----------------------------------------------------------| |-----------|
| | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
|-----------------------------------------------------------| '-----------'
| | | | | | | | | | | | | |
|-----------------------------------------------------------| ,---.
| | | |Clc| | | | | | | |Caps | | |
|-----------------------------------------------------------| ,-----------.
| | | | | | | | | | | |
`-----------------------------------------------------------' `-----------'