andrejl
/
qmk-dactyl-manuform-a
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qmk-dactyl-manuform-a/keyboards/bpiphany/pegasushoof/keymaps/citadel
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
..
config.h Keyboard: Bpiphany Pegasus Hoof Refactor, Configurator support (#4649) 2018-12-14 16:38:46 -08:00
keymap.c Add C(), A() and G() to match already existing S() (#4673) 2019-01-25 13:12:48 -08:00
readme.md Keyboard: Move Bathroom Epiphany boards into its own directory (#3936) 2018-09-19 16:25:58 -07:00
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00

readme.md

Citadel keymap for pegasushoof

Designed for ISO-DE and similar ISO layouts.

The central idea of this keymap is to avoid unergonomic key combos that force the user to either press multiple keys with one hand or to use the left hand for right-sided keys. For instance, ISO-DE users have to press AltGr+7 to type {. The keymap allows ergonomic access to the right-sided keys of the German AltGr-layer by turning Caps Lock into a hybrid Fn/AltGr-key. It can easily be adapted for other ISO layouts.

The Function layer also offers mouse emulation and function/media keys in the F-Row.

Pause/Break is used as a safe close key: A single tap does nothing, a double tap executes ALT+F4.

Named after the homonymous space station from Mass Effect. Made by Daniel Rose.

[1] Layers

Layer 1 (Default)

.----.   .-------------------. .-------------------. .-------------------. .--------------.  
|Esc |   |F1  |F2  |F3  |F4  | |F5  |F6  |F7  |F8  | |F9  |F10 |F11 |F12 | |PrSc|SLck|2Tp:|  
|    |   |    |    |    |    | |    |    |    |    | |    |    |    |    | |SyRq|    |A+F4|  
'----'   '-------------------' '-------------------' '-------------------' '--------------'  
.------------------------------------------------------------------------. .--------------.  
|°   |!   |"   |§   |$   |%   |&   |/   |(   |)   |=   |?   |`   |Backspa| |Ins |Home|PgUp|  
|^   |1   |2  ²|3  ³|4   |5   |6   |7  {|8  [|9  ]|0  }|ß  \|´   |       | |    |    |    |  
|------------------------------------------------------------------------| |--------------|  
|Tab   |Q   |W   |E   |R   |T   |Z   |U   |I   |O   |P   |Ü   |*   |  E  | |Del |End |PgDn|  
|      |    |    |   €|    |    |    |    |    |    |    |    |+  ~|  n  | |    |    |    |  
|------------------------------------------------------------------\  t  | '--------------'  
|Fn:    |A   |S   |D   |F   |G   |H   |J   |K   |L   |Ö   |Ä   |'   | e  |  
|Layer 2|    |    |    |    |    |    |    |    |    |    |    |#   | r  |  
|------------------------------------------------------------------------|      .----.  
|Shift|>   |Y   |X   |C   |V   |B   |N   |M   |;   |:   |_   |Shift      |      |Up  |  
|     |<  ¦|    |    |    |    |    |    |   µ|,   |.   |-   |           |      |    |  
|------------------------------------------------------------------------| .--------------.  
|Ctrl |Super|Alt  |                              |AltGr|Alt  |Fn:  |Ctrl | |Left|Down|Righ|  
|     |     |     |                              |     |     |Lay 2|     | |    |    |    |  
'------------------------------------------------------------------------' '--------------'

Layer 2 (Function)

.----.   .-------------------. .-------------------. .-------------------. .--------------.  
|Ctl+|   |My  |WWW:|Calc|Medi| |Mus:|Mus:|Mus:|Mus:| |Vol:|Vol:|Vol:|See:| |    |    |Paus|  
|A+De|   |Comp|Home|    |Play| |Prev|Next|Paus|Stop| |Mute|Down|Up  |[3] | |    |    |Brea|  
'----'   '-------------------' '-------------------' '-------------------' '--------------'  
.------------------------------------------------------------------------. .--------------.  
|    |    |    |    |    |    |    |    |    |    |    |    |    |       | |    |    |Mou:|  
|    |    |    |    |    |    |    |{   |[   |]   |}   |\   |    |       | |    |    |WhUp|  
|------------------------------------------------------------------------| |--------------|  
|      |    |    |    |    |    |    |    |    |    |    |    |~   |     | |    |    |Mou:|  
|      |    |    |    |    |    |    |    |    |    |    |    |    |     | |    |    |WhDn|  
|------------------------------------------------------------------\     | '--------------'  
|CapsLck|Mou:|Mou:|    |    |    |    |    |    |    |    |    |    |    |  
|       |Fast|Slow|    |    |    |    |    |    |    |    |    |    |    |  
|------------------------------------------------------------------------|      .----.  
|     |    |    |    |    |    |    |    |µ   |    |    |    |           |      |Mou:|  
|     |    |    |    |    |    |    |    |    |    |    |    |           |      |Up  |  
|------------------------------------------------------------------------| .--------------.  
|Mous:|Mous:|     |                              |     |Super|App  |     | |Mou:|Mou:|Mou:|  
|Bttn2|Bttn1|     |                              |     |     |     |     | |Left|Down|Righ|  
'------------------------------------------------------------------------' '--------------'

Layer 3 exists solely to prevent users from accidentally activating boot mode: R is redefined as RESET key [3].

[2] How to build and install

  1. Prerequisite: install the necessary build tools such as dfu-programmer.
  2. To test if the keymap compiles, simply run make pegasushoof:citadel
  3. Enter the qmk_firmware root directory and run make pegasushoof:citadel:dfu
  4. Reset controller to Boot mode by pressing the RESET key or by using a magnet.

[3] How to access Boot mode after install

Press Fn+F12+R