mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-21 00:53:23 +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 | ||
| rgb_matrix_user.inc | ||
| rules.mk | ||
buffet's planck layout
Layout
The Layout is based on keychords. The general idea is that you're able to type everything with either hand, so that you can alternate between hands as you type.
The keys are in a 2x4 block in the top left and top right respectively (mirrored).
They have greek letter names (see keymap.c for more info).
Thumb added to any key means shift is pressed as well.
- means the finger presses nothing.
^ means the finger presses the upper row.
v means the finger presses the lower row.
Space: thumb
Return: vvvv vvvv
Tab: vv^v v^vv
Bspace: v--v v--v
Esc: lower pinky and thumb
Letters
a: -^-- --^-
b: -v-^ ^-v-
c: -^^^ ^^^-
d: -vvv vvv-
e: ---^ ^---
f: --^v v^--
g: -^v- -v^-
h: -vv- -vv-
i: --^- -^--
j: -^^v v^^-
k: -^vv vv^-
l: -^^- -^^-
m: -^-^ ^-^-
n: -v-- --v-
o: --v- -v--
p: -v^- -^v-
q: -^v^ ^v^-
r: --^^ ^^--
s: --vv vv--
t: ---v v---
u: -v-v v-v-
v: --v^ ^v--
w: -v^v v^v-
x: -vv^ ^vv-
y: -^-v v-^-
z: -v^^ ^^v-
Numbers and Symbols
0: vv-- --vv
1: vv-v v-vv
2: vvv- -vvv
3: v^-- --^v
4: v^-^ ^-^v
5: v^^- -^^v
6: v^-v v-^v
7: v-v- -v-v
8: v^^v v^^v
9: v-^^ ^^-v
-: v^vv vv^v
=: vvv^ ^vvv
[: vv^- -^vv
]: v-^v v^-v
\: v^v- -v^v
;: v^^^ ^^^v
': vv-^ ^-vv
,: v-vv vv-v
.: vv^^ ^^vv
/: v-^- -^-v
`: v--^ ^--v
Modifiers
Modifiers all use the top pinky key, and a combinations of modifiers you want to activate for the next keypress (very similar to how OMS work). For the modifiers the top row of keys is used.
Control: Ringfinger
Shift: Middlefinger
Alt: Indexfinger
Super: Thumb
^--v v--^ can be used to lock the next modifier input.
Remaining
These combinations are unused.
v^v^
v-v^
v---