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_en.md | ||
| readme_jp.md | ||
| rules.mk | ||
The Default Zinc Layout
layout
Qwerty
,-----------------------------------------. ,-----------------------------------------.
| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc | Fn | Alt | Win |Lower |Space | | Space| Raise| Left | Down | Up | Right|
`------------------------------------------ ------------------------------------------'
Colemak
,-----------------------------------------. ,-----------------------------------------.
| Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | R | S | T | D | | H | N | E | I | O | ' |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| Z | X | C | V | B | | K | M | , | . | / |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
`------------------------------------------ ------------------------------------------'
Dvorak
,-----------------------------------------. ,-----------------------------------------.
| Tab | ' | , | . | P | Y | | F | G | C | R | L | Del |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | O | E | U | I | | D | H | T | N | S | / |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| ; | Q | J | K | X | | B | M | W | V | Z |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
`-----------------------------------------' `-----------------------------------------'
Lower
,-----------------------------------------. ,-----------------------------------------.
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | - | _ | + | { | } | | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | | Home | End | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | Next | Vol- | Vol+ | Play |
`-----------------------------------------' `-----------------------------------------'
RAISE
,-----------------------------------------. ,-----------------------------------------.
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | F7 | F8 | F9 | F10 | F11 | | F12 | | | | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | Next | Vol- | Vol+ | Play |
`-----------------------------------------' `-----------------------------------------'
Adjust (Lower + Raise)
,-----------------------------------------. ,-----------------------------------------.
| | Reset|RGBRST|Aud on|Audoff| | | |Qwerty|Colemk|Dvorak| | Ins |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
|------+------+------+------+------+------| |------+------+------+------+------+------|
|MODE R|RGBMOD| HUE- | SAT- | VAL- | | | | | | |PageUp| |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | EISU | EISU | EISU | | KANA | KANA | KANA | Home |PageDn| End |
`-----------------------------------------' `-----------------------------------------'
Compile
go to qmk top directory.
$ cd qmk_firmware
make with zinc:<keymap_name>
$ make zinc:default
To make and flash with :flash
$ make zinc:default:flash
Customize
You can customize from the command line.
# Zinc keyboard 'default' keymap: convenient command line option
make ZINC=<options> zinc:defualt
# option= back | under | both | cont | na | ios
# ex.
# make ZINC=under zinc:defualt
# make ZINC=under,ios zinc:defualt
# make ZINC=back zinc:default
# make ZINC=back,na zinc:default
# make ZINC=back,ios zinc:default
Or edit qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk directly.
# Zinc keyboard customize
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
LED_BOTH_ENABLE = no # LED backlight and underglow
LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
LED_ANIMATIONS = yes # LED animations
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)