qmk-firmware/keyboards/projectkb/alice
James Young a03aa301de
Remove Full Bootmagic (#13846)
* 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
2021-08-06 23:59:56 -07:00
..
keymaps Rework LAYOUT_alice support; add LAYOUT_alice_split_bs (#11106) 2020-12-03 14:07:41 -08:00
rev1 Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
rev2 Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
.noci Initial list of keyboards to exclude from CI (#11213) 2020-12-21 15:38:39 +01:00
alice.c Fix project alice indicators (#9342) 2020-06-13 00:06:38 -07:00
alice.h Rework LAYOUT_alice support; add LAYOUT_alice_split_bs (#11106) 2020-12-03 14:07:41 -08:00
chconf.h ChibiOS conf migrations... take 11 (#11646) 2021-01-21 17:00:53 +11:00
config.h 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
halconf.h 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
info.json Rework LAYOUT_alice support; add LAYOUT_alice_split_bs (#11106) 2020-12-03 14:07:41 -08:00
mcuconf.h 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
readme.md [Keyboard] ProjectKB Alice rev2 (#8718) 2020-04-15 15:37:47 -07:00
rules.mk Rework LAYOUT_alice support; add LAYOUT_alice_split_bs (#11106) 2020-12-03 14:07:41 -08:00

ProjectKeyboard Alice PCB

ProjectKeyboard Alice Keyboard Replacement PCB

Keyboard Maintainer: onefiftynine

Hardware Supported: STM32F072CBT6
Make example for this keyboard (after setting up your build environment):

make projectkb/alice/rev2:default

If you are flashing this keyboard/pcb for the first time:

* Set the dip switch on the reverse of the PCB to 1
* Hit the reset button and then do
* make projectkb/alice:default:dfu-util
* After flashing the keyboard successfully, you can reset the dip switch back to 0

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.