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
|
||
|---|---|---|
| .. | ||
| ab | ||
| abishalom | ||
| adamtabrams | ||
| ajp10304 | ||
| alexey | ||
| altgr | ||
| am | ||
| andylikescandy | ||
| angerthosenear | ||
| atreus | ||
| austin | ||
| aviator | ||
| badger | ||
| basic | ||
| bbaserdem | ||
| bghull | ||
| bone2planck | ||
| brandon | ||
| buffet | ||
| buhearns | ||
| cbbrowne | ||
| chance | ||
| charlesrocket | ||
| charlie | ||
| circuit | ||
| coloneljesus | ||
| copface | ||
| corvec | ||
| csc027 | ||
| daniel | ||
| danielhklein | ||
| david | ||
| davidrambo | ||
| dbroqua | ||
| dc | ||
| dcompact | ||
| dear_vehicle_owner | ||
| default | ||
| deft | ||
| dlaroe | ||
| dodger | ||
| dr0ck | ||
| dr_notsokind | ||
| dsanchezseco | ||
| dshields | ||
| dudeofawesome | ||
| dvorak2space | ||
| dzobert | ||
| emiller | ||
| emilyh | ||
| eosti | ||
| eshesh2 | ||
| espynn | ||
| experimental | ||
| fabian | ||
| fsck | ||
| gabriel | ||
| gitdrik | ||
| grahampheath | ||
| grant24 | ||
| gunp | ||
| handwired_binaryplease | ||
| hiea | ||
| hieax | ||
| hvp | ||
| impossible | ||
| ishtob | ||
| jacob | ||
| jasperla | ||
| jcorrado | ||
| jdelkins | ||
| jeebak | ||
| jeremy-dev | ||
| jetpacktuxedo | ||
| jhenahan | ||
| jirgn | ||
| joe | ||
| johannes | ||
| kanbara | ||
| kelorean | ||
| khord | ||
| kifinnsson | ||
| kloki | ||
| kmontag42 | ||
| kyle | ||
| lae3 | ||
| leo | ||
| lja83 | ||
| lucas | ||
| lukas | ||
| luke | ||
| mason | ||
| matrixman | ||
| mattly | ||
| max | ||
| mgalisa | ||
| mikethetiger | ||
| mitch | ||
| mjt | ||
| mjtnumsym | ||
| mjuma | ||
| mnil | ||
| mollat | ||
| motform | ||
| msiu | ||
| muzfuz | ||
| mwpeterson | ||
| myoung34 | ||
| narze | ||
| navi | ||
| neo2planck | ||
| nick | ||
| nico | ||
| not-quite-neo | ||
| originerd | ||
| orthodeluxe | ||
| oryx | ||
| paget | ||
| palleiko | ||
| pascamel | ||
| pete | ||
| pevecyan | ||
| phreed | ||
| pickle_jr | ||
| piemod | ||
| pok3r | ||
| premek | ||
| priyadi | ||
| ptillemans | ||
| pvc | ||
| raffle | ||
| rai-suta | ||
| rjhilgefort | ||
| rodhaene | ||
| roguepullrequest | ||
| samuel | ||
| sascha | ||
| sdothum | ||
| sean | ||
| sebas | ||
| sgoodwin | ||
| sigul | ||
| skank | ||
| skug | ||
| smittey | ||
| smt | ||
| snowkuma | ||
| spacebarracecar | ||
| steno | ||
| stuartfong1 | ||
| synth_sample | ||
| synth_wavetable | ||
| tak3over | ||
| tehwalris | ||
| that_canadian | ||
| thermal_printer | ||
| tk | ||
| tom | ||
| tong92 | ||
| ttys0 | ||
| tylerwince | ||
| unagi | ||
| unicode | ||
| vaire | ||
| via | ||
| vifon | ||
| vxid | ||
| winternebs | ||
| xjtian | ||
| yale | ||
| yang | ||
| yhaliaw | ||
| yttyx | ||
| zach | ||
| zrichard | ||
| readme.md | ||
readme.md
How to add your own keymap
Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding _:
_[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author]
* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements
and contain the following files:
keymap.creadme.mdrecommendedconfig.hoptional, found automatically when compilingMakefileoptional, found automatically when compiling
When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format:
* **folder_name** description
List of Planck keymaps
- default default Planck layout
- cbbrowne cbbrowne's Planck layout