Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@struckmb
struckmb committed Apr 9, 2023
1 parent 56a4a86 commit 1a8277b
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 44 deletions.
23 changes: 3 additions & 20 deletions users/struckmb/keycodes.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,16 +199,8 @@ to add/remove underscores to keep the lengths consistent.
#define _____________________NUMBER_R0____________________6_ KC_6, KC_7, KC_8, KC_9, KC_0, KC_NO
#define ______________________FUNC_L0_____________________6_ KC_F11, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5
#define ______________________FUNC_R0_____________________6_ KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F12
// /*
// * Standard thumb cluster
// | PgUp | PgDn │ Esc │Enter│ App | |BkSpc│Space│ Tab │OsMeh |OsHypr|
// ------+------└─Fn──┴─Num─┴-Mse- -Cfg-┴─Sym─┴─Nav─┘------+------
// *
// * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
// * | PgUp | PgDn |MsCtl/|SymNr/|NavFn/| | Adj/|SymNr/|NavFn/| | |
// * | | | Esc | Ent | Menu | | BSp | Spc | Tab | | |
// * `----------------------------------' `----------------------------------'
// */

// /* Standard thumb cluster */
#define __THUMB_2_L___2_ NF_ESC, SY_ENT
#define __THUMB_2_R___2_ SN_SPC, NF_TAB
#define _________THUMB_2_2_______4_ __THUMB_2_L___2_, __THUMB_2_R___2_
Expand Down Expand Up @@ -247,15 +239,6 @@ to add/remove underscores to keep the lengths consistent.
#define __________________NUMBERS________________5_ DE_0, DE_1, DE_2, DE_4, DE_8
#define _________________FUNCTIONS_______________5_ KC_F10, KC_F1, KC_F2, KC_F4, KC_F8

// ┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐------
// │ @ │ _ │ [ │ ] │ ^ ° │ │ 0 = │ 1 ! │ 2 " │ 4 $ │ 8 ( │ ! |
// ├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤------
// │ \ │ / │ { │ } │ * │ │ < > │ ( │ ) │ - _ │ & │ = |
// ├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤------
// │ # ' │ $ │ | │ ~ │ ´ │ │ + * │ % │ " │ ' │ € │ |
// └─────┴─────┴─────┼─────┼─────┼─────┐ ┌─────┼─────┼─────┼─────┴─────┴─────┘------
// │ § │ │ │ │ │ │ ¢ │
// └─────┴─────┴─────┘ └─────┴─────┴─────┘
#define ________________SYMBOLS_L1_______________5_ DE_AT, DE_UNDS, DE_LBRC, DE_RBRC, DE_CIRC
#define ________________SYMBOLS_L2_______________5_ DE_BSLS, DE_SLSH, DE_LCBR, DE_RCBR, DE_ASTR
#define ________________SYMBOLS_L3_______________5_ DE_HASH, DE_DLR, DE_PIPE, DE_TILD, DE_ACUT
Expand Down Expand Up @@ -332,7 +315,7 @@ to add/remove underscores to keep the lengths consistent.
// ┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐
// │ TOGG│Plain│Brthe│Rainb│Swirl│ │(BtC)│(Bt←)│(Bt0)│(Bt→)│(Out)│
// ├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤
// │Speed│ Val │ Sat │ Hue │ Mode│ │EEClr│QWERT│COLDH│BONEO│LYPND│
// │Speed│ Val │ Sat │ Hue │ Mode│ │EEClr│QWERT│COLMK│ BONE│LYPND│
// ├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼Mouse┼─────┼─────┤
// │ Test│ Xmas│Grdnt│Knght│Snake│ │Reset│ ASET│ARTSN│ XXX │ Sft │
// └─────┴─────┴─────┼─────┼─────┼─────┐ ┌─────┼─────┼─────┼─────┴─────┴─────┘
Expand Down
67 changes: 43 additions & 24 deletions users/struckmb/readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,66 +1,85 @@

# Base Layers

## Home row mod, thumb keys and 6th rows
This is added to all base layers
```
-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----
| Tab │ │ │ │ │ │ │ │ │ │ │ │ |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
| C/E │ │ │(Gui)│(Ctl)│(Alt)│ │(Alt)│(Ctl)│(Gui)│ │(Adj)│(Alt)|
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
| Tab │ │ │ │ │ │ │ │ │ │(Mse)│ │ |
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| C/E │ │ │(Gui)│(Ctl)│(Alt)│ │(Alt)│(Ctl)│(Gui)│ │ │(Alt)|
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| Sft │(Sft)│ │ │ │ │ │ │ │ │ │(Sft)│(RSh)|
-----└─────┴─────┼─────┼─────┼─────┼----- -----┼─────┼─────┼─────┼─────┴─────┘-----
'-----└─────┴─────┴─────┼─────┼─────┼-----. .-----┼─────┼─────┼─────┴─────┴─────┘-----'
| PUp | PDn │ Esc │Enter│ App | |BkSpc│Space│ Tab │OsMeh|OsHyp|
'-----+-----└─Fn──┴─Num─┴-----' '-----┴─Sym─┴─Nav─┘-----+-----'
```
Pressing Fn+Nav simultaniously activates Adj layer

## Base Layout - QWERTZ
If QWERTZ_ENABLE is defined, you can switch to the following map using QWERTZ
```
-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
| Tab │ q │ w │ e │ r │ t │ │ z │ u │ i │ o │ p │ ü |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| C/E │ a │ s │ d │ f │ g │ │ h │ j │ k │ l │ ö │ ä |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| Sft │ y │ x │ c │ v │ b │ │ n │ m │ , ; │ . : │ ß ? │ |
-----└─────┴─────┼─────┼─────┼─────┼----- -----┼─────┼─────┼─────┼─────┴─────┘-----'
'-----└─────┴─────┼─────┼─────┼─────┼-----. .-----┼─────┼─────┼─────┼─────┴─────┘-----'
```

## Base Layout - BONE (matrix)
If BONE_ENABLE is defined, you can switch to the following map using BONE
```
-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
| Tab │ j │ d │ u │ a │ x │ │ p │ h │ l │ m │ w │ ß |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| C/E │ c │ t │ i │ e │ o │ │ b │ n │ r │ s │ g │ q |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
| Sft │ f │ v │ ü/ß*│ ä/q*│ ö │ │ y │ z │ , ; │ . : │ k │ |
-----└─────┴─────┼─────┼─────┼─────┼----- -----┼─────┼─────┼─────┼─────┴─────┘-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| Sft │ f │ v │ ß/ü*│ q/ä*│ ö │ │ y │ z │ , ; │ . : │ k │ |
'-----└─────┴─────┼─────┼─────┼─────┼-----. .-----┼─────┼─────┼─────┼─────┴─────┘-----'
```
*) on 5 column keyboards the missing keys are moved to here. Use the umlauts
from layer MOUSE in this case
from MOUSE layer in that case.

## Base Layout - Colemak DH (german variant)
If COLEMAK_ENABLE is defined, you can switch to the following map using COLMAK
```
-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
| Tab │ q │ w │ f │ p │ b │ │ j │ l │ u │ z │ ö │ ü |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| C/E │ a │ r │ s │ t │ g │ │ m │ n │ e │ i │ o │ ä |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| Sft │ y │ x │ c │ d │ v │ │ k │ h │ , ; │ . : │ ß │ |
-----└─────┴─────┼─────┼─────┼─────┼----- -----┼─────┼─────┼─────┼─────┴─────┘-----
'-----└─────┴─────┼─────┼─────┼─────┼-----. .-----┼─────┼─────┼─────┼─────┴─────┘-----'
```

## Base Layout - Lilypond
If LILYPOND_ENABLE is defined, you can switch to the following map using LILYPOND
```
-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐-----.
| Tab │ q │ w │ j │ r │ t │ │ z │ u │ l │ o │ p │ ü |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| C/E │ h │ c │ d │ e │ i │ │ s │ f │ g │ a │ b │ ä |
-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤-----|
| Sft │ y │ x │ k │ v │ ö │ │ n │ m │ , ; │ . : │ ß │ |
-----└─────┴─────┼─────┼─────┼─────┼----- -----┼─────┼─────┼─────┼─────┴─────┘-----
'-----└─────┴─────┼─────┼─────┼─────┼-----. .-----┼─────┼─────┼─────┼─────┴─────┘-----'
```

# Other layers

## Symbol/Numbers layer
```
.-----┌─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┐------.
| │ @ │ _ │ [ │ ] │ ^ ° │ │ 0 = │ 1 ! │ 2 " │ 4 $ │ 8 ( │ ! |
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤------|
| │ \ │ / │ { │ } │ * │ │ < > │ ( │ ) │ - _ │ & │ = |
|-----├─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┤------|
| │ # ' │ $ │ | │ ~ │ ´ │ │ + * │ % │ " │ ' │ € │ |
'-----└─────┴─────┴─────┼─────┼─────┼─────┐ ┌─────┼─────┼─────┼─────┴─────┴─────┘------'
│ § │ │ │ │ │ │ ¢ │
└─────┴─────┴─────┘ └─────┴─────┴─────┘
```

# Copyright
Copyright 2023 Björn Struckmeier [email protected] @struckmb
Expand Down

0 comments on commit 1a8277b

Please sign in to comment.