fern/qmk-firmware
1
0
Fork 0
mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-22 19:40:29 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
qmk-firmware/layouts/community/ergodox/colemak_code_friendly
History
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
..
keymap.c [Keymap] Adds layout for Ergodox, colemak_code_friendly (#4819) 2019-01-11 17:39:24 -08:00
readme.md [Keymap] Adds layout for Ergodox, colemak_code_friendly (#4819) 2019-01-11 17:39:24 -08:00
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00

readme.md

ErgoDox EZ Code Friendly Colemak Layout

This layout was inspired by qwerty_code_friendly layout.

Having all the symbols accessible without modifiers is a good improvement for coding.

There are only two layouts which is easy to memorize.

There are two "Super shifts", LNUM and RNUM, placed on the most convenient physical keys. Each of them act as shift for the opposite side of the keyboard, and as a modifier key for the current side (usage similar to AltGr in many national layouts). This is achieved by duplicating the corresponding parts of Layer 0 and 1 into Layer 3 and 4. As a bonus, pressing both keys toggles Caps-Lock.

The numerical keypad is composed from regular number keys, works even in macOS.

Keymap 0: Basic layer

.--------------------------------------------------.  .--------------------------------------------------.
| Grave  |   !  |   @  |   #  |   $  |   %  |   ^  |  | TG(1)|   &  |   *  |   (  |   )  |   -  |  Bspc  |
|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
| Tab    |   Q  |   W  |   F  |   P  |   G  |   =  |  |  _   |   J  |   L  |   U  |   Y  |   ;  |   \    |
|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
| Esc    |   A  |   R  |   S  |   T  |   D  |------|  |------|   H  |   N  |   E  |   I  |   O  |  '     |
|--------+------+------+------+------+------|   {  |  |  }   |------+------+------+------+------+--------|
| LShift |Z/LCtl|X/Supe|   C  |   V  |B/RAlt|      |  |      |K/RAlt|   M  |   ,  |./Supe|/ RCtl| RShift |
'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
  | LCtl |Super | Alt  |   [  |   ]  |                              | Left | Down | Up   |Right | Del  |
  '----------------------------------'                              '----------------------------------'
                                     .-------------.  .-------------.
                                     | Home | End  |  | Ins  |ScrLck|
                              .------+------+------|  |------+------+------.
                              |      |      |PrnScr|  | PgUp |      |      |
                              | LNUM | Enter|------|  |------| Space| RNUM |
                              |      |      | Super|  | PgDn |      |      |
                              '--------------------'  '--------------------'

Keymap 1: Numbers, Macro Record

.--------------------------------------------------.  .--------------------------------------------------.
|        |      |      |      |      |  <>  |      |  |      |      |   *  |   (  |  )   |  -   |        |
|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
|        |  F12 |  F11 |  F10 |  F9  |  {}  |      |  |  =   |  =>  |   7  |   8  |   9  |  +   |        |
|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
|        |  F8  |  F7  |  F6  |  F5  |  ()  |------|  |------|  ->  |   4  |   5  |   6  |  0   |        |
|--------+------+------+------+------+------|      |  | Enter|------+------+------+------+------+--------|
|        |  F4  |  F3  |  F2  |  F1  |  []  |      |  |      |  !=  |   1  |   2  |   3  |      |        |
'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
  | MUTE | VOLD | VOLU |      |      |                              |   0  |   ,  |   .  |      |      |
  '----------------------------------'                              '----------------------------------'
                                     .-------------.  .-------------.
                                     |      |      |  |      | Stop |
                              .------+------+------|  |------+------+------.
                              |      |      |Start1|  |Start2|      |      |
                              |      |      |------|  |------|      |      |
                              |      |      |Play1 |  |Play2 |      |      |
                              '--------------------'  '--------------------'

Keymap 2: Left side -> LAYER_NUM, Right side -> Shift + LAYER_BASE

.--------------------------------------------------.  .--------------------------------------------------.
|        |      |      |      |      |  <>  |      |  | TG(1)|   &  |   *  |   (  |   )  |   -  |  Bspc  |
|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
|        |  F12 |  F11 |  F10 |  F9  |  {}  |      |  |  _   |   J  |   L  |   U  |   Y  |   ;  |   \    |
|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
|        |  F8  |  F7  |  F6  |  F5  |  ()  |------|  |------|   H  |   N  |   E  |   I  |   O  |  '     |
|--------+------+------+------+------+------|      |  |  }   |------+------+------+------+------+--------|
|        |  F4  |  F3  |  F2  |  F1  |  []  |      |  |      |K/RAlt|   M  |   ,  |./Supe|/ RCtl| RShift |
'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
  | MUTE | VOLD | VOLU |      |      |                              | Left | Down | Up   |Right | Del  |  
  '----------------------------------'                              '----------------------------------'  
                                     .-------------.  .-------------.
                                     |      |      |  | Ins  |ScrLck|
                              .------+------+------|  |------+------+------.
                              |      |      |Start1|  | PgUp |      |      |
                              |      |      |------|  |------| Space|CapsLk|
                              |      |      |Play1 |  | PgDn |      |      |
                              '--------------------'  '--------------------'

Keymap 3: Left side -> Shift + LAYER_BASE, Right side -> LAYER_NUM

.--------------------------------------------------.  .--------------------------------------------------.
| Grave  |   !  |   @  |   #  |   $  |   %  |   ^  |  |      |      |   *  |   (  |  )   |  -   |        |
|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
| Tab    |   Q  |   W  |   F  |   P  |   G  |   =  |  |  =   |  =>  |   7  |   8  |   9  |  +   |        |
|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
| Esc    |   A  |   R  |   S  |   T  |   D  |------|  |------|  ->  |   4  |   5  |   6  |  0   |        |
|--------+------+------+------+------+------|   {  |  | Enter|------+------+------+------+------+--------|
| LShift |Z/LCtl|X/Supe|   C  |   V  |B/RAlt|      |  |      |  !=  |   1  |   2  |   3  |      |        |
'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
  | LCtl |Super | Alt  |   [  |   ]  |                              |   0  |   ,  |   .  |      |      |
  '----------------------------------'                              '----------------------------------'
                                     .-------------.  .-------------.
                                     | Home | End  |  |      | Stop |
                              .------+------+------|  |------+------+------.
                              |      |      |PrnScr|  |Start2|      |      |
                              |CapsLk| Enter|------|  |------|      |      |
                              |      |      | Super|  |Play2 |      |      |
                              '--------------------'  '--------------------'