mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-23 03:42:59 +00:00
a03aa301de
* disambiguate Bootmagic rules in keymaps
The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.
This commit edits the files to specify that full Bootmagic is intended.
* remove BOOTMAGIC_ENABLE=full setting
* unify commented BOOTMAGIC_ENABLE rules in keyboards
Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no # Virtual DIP switch configuration;g' {} +
```
* remove commented Bootmagic rules from keymap/user level
Command:
```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```
* update keyboard BOOTMAGIC_ENABLE rule formatting
Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```
* update keyboards' BOOTMAGIC_ENABLE settings
Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```
* update keymap/user BOOTMAGIC_ENABLE settings
Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```
* remove and replace inline comments in keyboards and keymap/user files
Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' +
```
* rename improperly named makefiles
Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.
This commit corrects the filenames of the affected files.
* update renamed file with new rule formatting
* update QMK's template files
Updates QMK's `rules.mk` templates to use the new inline comment.
* update QMK Docs
- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes
* rules.mk patch for coarse/ixora and coarse/vinta
|
||
|---|---|---|
| .. | ||
| config.h | ||
| keymap.c | ||
| readme.md | ||
| rules.mk | ||
I've changed my folder name to match my GitHub username. Please see https://github.com/qmk/qmk_firmware/tree/master/keyboards/kinesis/keymaps/tuesdayjohn for my current keymap files.
insertsnideremarks' Kinesis Keymap
These layouts are derived from what I was using on my Kinesis Contoured keyboards with Hasu's USB-USB TMK converters. With the move to QMK via Stapelberg replacement controller, I've cleaned up the layouts a bit while adding more functions and layers.
There are minor changes in the base keywell layout of non-alpha keys (e.g., CapsLock is ESC/Ctl, arrow clusters on one side), while the thumb clusters deviate more from the default layout.
Changes to the thumb clusters include:
- The navigations keys moved to function layers.
- The function of 2u keys have been reversed - I've always used space with my left thumb, and I find it more helpful to have access to Space and Enter while using my mouse/trackball.
- Backspace have been duplicated on both clusters.
- The 2u keys serve dual function as momentary layer switchers.
I've largely left the function keys untouched, with the intension of not using them. They are neither easy to use nor reach due to their locations and size, and the rubber domes used were terrible. They have since replaced the keys with Cherry ML switches on Advantage2, but did not resolve the issues of size or location. Additionally, leaving the function keys unused here makes it easier for me to adapt the keymaps to my other keyboards, most of which do not have physical function keys.
I use Colemak as my default layout. I've included QWERTY here as well.
Additionally, I've added gaming/vanilla version of Colemak and QWERTY layouts. These layouts have limited access to the Function or Numbers/Symbols layers, and are mainly used for gaming.
Persistent default layer has been enabled for Colemak and QWERTY. The gaming/vanilla Colemak and QWERTY can be set as default layer, but will not be persistent.
Future plans
- Add status LEDs to the Stapelberg PCB (usually used for Caps Lock, Num Lock, and Scroll Lock) to use as layer indicators.
- Add a speaker now that QMK supports additional pins for audio use.
- Utilize the leftover spots on the key matrix, as well as unused pins on Teensy++ 2.0 to run macropad and/or foot pedals.
Colemak
(Default layer; keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
,-----------------------------------------------------------------------------------------------------------.
| ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Tab | Q | W | F | P | G | | J | L | U | Y | ; | \ |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
|Esc/Ctrl| A | R | S | T | D | | H | N | E | I | O | ' |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
|SC Shift| Z | X | C | V | B | | K | M | , | . | / |SC Shift|
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| Ins | ` | [ | ] | | Left | Down | Up | Right|
`---------------------------' `---------------------------'
,---------------. ,---------------.
|Esc/Ctl| Hyper | | RAlt | RCtl |
,-------|-------|-------| |-------+-------+-------.
| Space | Enter |App/Alt| | RGUI | Delete| Bspc |
| / | / |-------| |-------| / | / |
| Fn | Number| Bspc | | Enter |Number2| Fn2 |
`-----------------------' `-----------------------'
QWERTY
(Keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
,-----------------------------------------------------------------------------------------------------------.
| ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Tab | Q | W | E | R | T | | Y | U | I | O | P | \ |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
|Esc/Ctrl| A | S | D | F | G | | H | J | K | L | ; | ' |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
|SC Shift| Z | X | C | V | B | | N | M | , | . | / |SC Shift|
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| Ins | ` | [ | ] | | Left | Down | Up | Right|
`---------------------------' `---------------------------'
,---------------. ,---------------.
|Esc/Ctl| Hyper | | RAlt | RCtl |
,-------|-------|-------| |-------+-------+-------.
| Space | Enter |App/Alt| | RGUI | Delete| Bspc |
| / | / |-------| |-------| / | / |
| Fn | Number| Bspc | | Enter |Number2| Fn2 |
`-----------------------' `-----------------------'
Numbers & Symbols layer
(Multiple characters: single-tap for first, double-tap for second)
,-----------------------------------------------------------------------------------------------------------.
| | | | | | | | | | | | | | | | | | |
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| F12 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | 6 | 7 | 8 | 9 | 0 | | ^ | & | * | ( | ) | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | 1 | 2 | 3 | 4 | 5 | | ! | @ | # | $ | % | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | . | / * | - _ | + = | | ` ~ | [ { | ] } | | | |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| ( | ) | [ { | ] } | | | | | |
`---------------------------' `---------------------------'
,---------------. ,---------------.
| | | | | |
,-------|-------|-------| |-------+-------+-------.
| | | | | | | |
| | |-------| |-------| | |
| | | | | | | |
`-----------------------' `-----------------------'
Function layer
,-----------------------------------------------------------------------------------------------------------.
| | | | | | | | | | | | | | | | | | |
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| F12 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | | Up | | | | | | Up |Ctrl+Y| | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| |Ctrl+A| Left | Down | Right|C+A+Tb| | PgUp | Right| Down | Left | Home | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| |Ctrl+Z|Ctrl+X|Ctrl+C|Ctrl+V| Bspc | | PgDn | Mute | Vol- | Vol+ | End | |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| | | | | | Prev | Play | Next | Stop |
`---------------------------' `---------------------------'
,---------------. ,---------------.
| | | | | |
,-------|-------|-------| |-------+-------+-------.
| | | | | | | |
| | |-------| |-------| | |
| | | | | | | |
`-----------------------' `-----------------------'
Numpad layer
(Left side duplicates layout from the Numbers layer, just with numpad output; right side layout close to PC numpad layout)
,-----------------------------------------------------------------------------------------------------------.
| | | | | | | | | | | | | | | | | | |
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| | NumLk| | | | | | Tab | NumLk| KP / | KP * | KP - | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | KP 6 | KP 7 | KP 8 | KP 9 | KP 0 | | | KP 7 | KP 8 | KP 9 | KP + | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | KP 1 | KP 2 | KP 3 | KP 4 | KP 5 | | | KP 4 | KP 5 | KP 6 | = | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | KP . |KP/KP*| KP- _| KP+ =| | | KP 1 | KP 2 | KP 3 |KP Ent| |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| ( | ) | [ { | ] } | | KP 0 | , | KP . |KP Ent|
`---------------------------' `---------------------------'
,---------------. ,---------------.
| | | | | |
,-------|-------|-------| |-------+-------+-------.
| | | | | | | |
| | |-------| |-------| | |
| | | | | | | |
`-----------------------' `-----------------------'
Colemak gaming/vanilla
(Limited access to Function or Numbers layers; mainly used for gaming; Ent/NS + Delete/Numbers2 to access Adjust layer)
,-----------------------------------------------------------------------------------------------------------.
| ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Tab | Q | W | F | P | G | | J | L | U | Y | ; | \ |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| LCtrl | A | R | S | T | D | | H | N | E | I | O | ' |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Shift | Z | X | C | V | B | | K | M | , | . | / | Shift |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| Ins | ` | [ | ] | | Left | Down | Up | Right|
`---------------------------' `---------------------------'
,---------------. ,---------------.
| Esc | | | RAlt | RCtl |
,-------|-------|-------| |-------+-------+-------.
| | | LAlt | | RGUI | Delete| Bspc |
| Space | Enter |-------| |-------| / | / |
| | | Bspc | | Ent/NS|Number2| Fn2 |
`-----------------------' `-----------------------'
QWERTY gaming/vanilla
(Limited access to Function or Numbers layers; mainly used for gaming; Ent/NS + Delete/Numbers2 to access Adjust layer)
,-----------------------------------------------------------------------------------------------------------.
| ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Tab | Q | W | E | R | T | | Y | U | I | O | P | \ |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| LCtrl | A | S | D | F | G | | H | J | K | L | ; | ' |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| Shift | Z | X | C | V | B | | N | M | , | . | / | Shift |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| Ins | ` | [ | ] | | Left | Down | Up | Right|
`---------------------------' `---------------------------'
,---------------. ,---------------.
| Esc | | | RAlt | RCtl |
,-------|-------|-------| |-------+-------+-------.
| | | LAlt | | RGUI | Delete| Bspc |
| Space | Enter |-------| |-------| / | / |
| | | Bspc | | Ent/NS|Number2| Fn2 |
`-----------------------' `-----------------------'
Adjust layer
(Press Enter/Number + Delete/Number2 under non-gaming/vanilla layers or press & hold Adjust key on function row; Numpad is a toggle)
,-----------------------------------------------------------------------------------------------------------.
| | | | | | | | | | | | | | | | | | |
`-----------------------------------------------------------------------------------------------------------'
,-------------------------------------------. ,-------------------------------------------.
| |Colmak|Qwerty| |ClmkGM| QWGM | |Numpad| | | | | RESET |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | | | | | | | | | | | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | | | | | | | NKRO | | | | |
|--------+------+------+------+------+------| |------+------+------+------+------+--------|
| | | | | | | | | | | | | |
`--------+------+------+------+------+------' `------+------+------+------+------+--------'
| | | | | | | | | |
`---------------------------' `---------------------------'
,---------------. ,---------------.
| | | | | |
,-------|-------|-------| |-------+-------+-------.
| | | | | | | |
| | |-------| |-------| | |
| | | | | | | |
`-----------------------' `-----------------------'