mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-15 04:54:43 +00:00
Code Issues Projects Releases Packages Wiki Activity
opensteno_qmk/keyboards/planck/keymaps/kanbara
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
keymap.c
readme.md
rules.mk

readme.md

kanbara's layout

This layout contains a Colemak and Qwerty mode (for easier pair programming with colleagues) as well as a mode specifically to play League of Legends, as the normal mode does not provide for accessible enough numbers and function keys

Base Layers (Qwerty/Colemak/League)

After lots of tweaking, I've found that putting brackets in the middle is easier for programming, and having a separate numpad input is quite handy.

  • Contains split space and enter
  • Designed for macOS
  • Keeps the Tab/Esc swap which I quite like
  • Note the removal of evil caps lock

Qwerty

,-----------------------------------------------------------------------------------.
| Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Adjst| Ctrl | Alt  | GUI  | SPC  | Lower| Raise| Enter| Left | Down |  Up  |Right |
`-----------------------------------------------------------------------------------'

Colemak

,-----------------------------------------------------------------------------------.
| Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Adjst| Ctrl | Alt  | GUI  | SPC  | Lower| Raise| Enter| Left | Down |  Up  |Right |
`-----------------------------------------------------------------------------------'

League

  • Has it's own raise just for F-keys and Ctrl+{Q,W,E,R} as a hold toggle
  • Just the base keys needed for the game + the adjust and backspace
,-----------------------------------------------------------------------------------.
| Tab  |  1   |  2   |  3   |  4   |  5   |  6   |  7   |      |      |      | Bksp |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Esc  |  Q   |  W   |  E   |  R   |  G   |      |      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|   P  |  B   |  S   |  D   |  F   |      |      |      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|Adjust|      |      |      |      | Spc  | Raise|      | Ent  |      |      |      |
`-----------------------------------------------------------------------------------'

Raise

,-----------------------------------------------------------------------------------.
|      |  F2  |  F3  |  F4  |  F5  |      |      |      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |Ctrl-Q|Ctrl-W|Ctrl-E|Ctrl-R|      |      |      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      |      |
`-----------------------------------------------------------------------------------'

Lower Layer (Programming symbols + numpad)

I've put a numpad on the right side, and brackets in the middle. I found that putting the shifted equivalents of -, +, \ and ~ are quite convenient to type with one hand

,-----------------------------------------------------------------------------------.
|   `  |      |   _  |   +  |   \  |   {  |   }  |      |   7  |   8  |   9  |  /   |
|------+------+------+------+------+------+------+------+------+------+------+------|
|   ~  |      |   _  |   =  |   |  |   [  |   ]  |      |   4  |   5  |   6  |  *   |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |   (  |   )  |      |   1  |   2  |   3  |  -   |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |  0   |   ,  |  .   |  +   |
`-----------------------------------------------------------------------------------'

Raise Layer (Function keys + shifted numbers)

Here are the Function keys, as well as shifted 1-9 in order, and some nav and OS keys

,-----------------------------------------------------------------------------------.
|   ~  |   F1 |   F2 |   F3 |   F4 |   F5 |  F6  |  F7  |  F8  |  F9  |  F10 | Home |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Del  |   !  |   @  |  #   |   $  |  %   |  ^   |  &   |  *   |      |      | PgUp |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      | Vol- |  BR- |  BR+ | Vol+ |      |      |      | PgDn |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      | End  |
`-----------------------------------------------------------------------------------'

Adjust Layer

Contains reset, debug and the layer on the right which are set in EEPROM across power transitions

,-----------------------------------------------------------------------------------.
|Reset |Debug |      |      |      |      |      |      |      |      |      |Qwerty|
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      |Colmk |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      |League|
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |      |      |      |      |      |      |      |
`-----------------------------------------------------------------------------------'