Skip to content

Commit 7982e74

Browse files
bcatbcat
committed
Refresh keymap documentation
1 parent a908ebe commit 7982e74

File tree

10 files changed

+95
-52
lines changed

10 files changed

+95
-52
lines changed

‎README.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,48 @@ I use community layouts wherever possible, only writing keyboard-specific
1010
keymaps for boards without standard layout support. I derive my keymaps from two
1111
canonical ones (preferred for typing and gaming, respectively).
1212

13-
## Canonical keymaps
13+
## Base keymaps
1414

15-
* [3x6+3 split layout](layouts/split_3x6_3/bcat)
16-
* Used on: Crkbd
17-
* Columnar-staggered split ergo layout, preferred for typing
15+
* [Split 3x6+3](layouts/split_3x6_3/bcat)
16+
* (Crkbd)
17+
* Columnar-staggered split ergo layout
18+
* Preferred for typing and productivity
1819

19-
* [60% ANSI Tsangan layout with split Backspace and Right
20-
Shift](layouts/60_ansi_tsangan_split_bs_rshift/bcat)
21-
* Used on: ai03 Polaris, CannonKeys AN-C, CannonKeys Instant60, DZ60
22-
* Row-staggered layout, preferred for gaming
20+
* [60% ANSI Tsangan (split Backspace, Right
21+
Shift)](layouts/60_ansi_tsangan_split_bs_rshift/bcat)
22+
* (ai03 Polaris, CannonKeys AN-C, CannonKeys Instant60, DZ60)
23+
* Traditional row-staggered layout
24+
* Preferred for gaming
2325

24-
## Additional keymaps
26+
## Derived keymaps
2527

2628
### Ergo
2729

2830
* [ai03 Altair-X](keyboards/ai03/altair_x/keymaps/bcat)
29-
* [Lily58 layout](keyboards/lily58/keymaps/bcat)
30-
* [Unicorne layout](keyboards/yanghu/unicorne/keymaps/bcat)
31+
* [Lily58](keyboards/lily58/keymaps/bcat)
32+
* [Unicorne](keyboards/yanghu/unicorne/keymaps/bcat)
3133

3234
### Ortho
3335

34-
* [Eco layout](keyboards/eco/keymaps/bcat)
36+
* [Eco](keyboards/eco/keymaps/bcat)
3537

3638
### Traditional
3739

38-
* [60% ANSI layout with split Backspace and Right
39-
Shift](layouts/60_ansi_split_bs_rshift/bcat)
40-
* Used on: DZ60
40+
* [60% ANSI (split Backspace, Right
41+
Shift)](layouts/60_ansi_split_bs_rshift/bcat)
42+
* (DZ60)
4143

42-
* [65% ANSI layout with blocker and split
43-
Backspace](layouts/65_ansi_blocker_split_bs/bcat)
44-
* Used on: KBDfans KBD67 hotswap
44+
* [65% ANSI (blocker and split
45+
Backspace)](layouts/65_ansi_blocker_split_bs/bcat)
46+
* (KBDfans KBD67 hotswap)
4547

46-
* [Keebio Quefrency 65% layout](keyboards/keebio/quefrency/keymaps/bcat)
48+
* [Keebio Quefrency 65%](keyboards/keebio/quefrency/keymaps/bcat)
4749

48-
### Macropads
50+
## Macropad keymaps
4951

50-
* [9-Key layout](keyboards/9key/keymaps/bcat)
52+
* [9-Key](keyboards/9key/keymaps/bcat)
5153

52-
* [Keebio BDN9 layout](keyboards/keebio/bdn9/keymaps/bcat)
54+
* [Keebio BDN9](keyboards/keebio/bdn9/keymaps/bcat)
5355

5456
## License
5557

‎keyboards/ai03/altair_x/keymaps/bcat/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ macro keys on each side.
77
<details>
88
<summary>Layout notes</summary>
99

10-
* Based on [split 3x6+3](/layouts/split_3x6_3/bcat) layout.
10+
* Based on [split 3x6+3](/layouts/split_3x6_3/bcat) layout. See that page for
11+
detailed rationale on keymap design.
1112
* The leftmost bottom row key is mapped to Alt, enabling easier access to combos
1213
like Alt+F4.
1314
* The rightmost bottom row key is mapped to Super rather than just hiding it in

‎keyboards/eco/keymaps/bcat/README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# bcat's Eco layout
22

3-
This is a cute little 4x14 ortholinear keyboard. I've set it up using an
4-
unsplit, ortho version of my [split 3x6 + 3 thumb
5-
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout with a few tweaks.
3+
This is a cute little 4x14 ortholinear keyboard that uses every IO pin available
4+
on a Pro Micro (or compatible) controller.
65

76
<details>
87
<summary>Layout notes</summary>
98

9+
* Based on [split 3x6+3](/layouts/split_3x6_3/bcat) layout. See that page for
10+
detailed rationale on keymap design.
1011
* The alpha keys are separated by an extra two columns in the middle to provide
1112
a little more hand separation, similar to a split keyboard.
1213
* The top three rows of the extra middle columns feature navigation keys and

‎keyboards/keebio/quefrency/keymaps/bcat/README.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# bcat's Quefrency 65% layout
22

3-
This is a standard 65% keyboard layout, with a split spacebar, an HHKB-style
4-
(split) Backspace plus function layer, and RGB controls in the adjust layer (on
5-
the arrow/nav keys).
3+
This is a split 65% keyboard layout with an HHKB-style (split) Backspace.
4+
5+
<details>
6+
<summary>Layout notes</summary>
7+
8+
* Based on [60% Tsangan](/layouts/60_ansi_tsangan_split_bs_rshift) layout. See
9+
that page for detailed rationale on keymap design.
10+
* The bottom row is laid out more like a traditional TKL keyboard, with the
11+
Super key on the left and Fn keys on each side.
12+
* Dedicated arrow and navigation keys replace the HHKB diamond cluster (which
13+
I've since grown to prefer).
14+
</details>
615

716
| Default layer ([KLE](http://www.keyboard-layout-editor.com/#/gists/60a262432bb340b37d364a4424f3037b)) |
817
| :-: |

‎keyboards/lily58/keymaps/bcat/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# bcat's Lily58 layout
22

3-
This split ergo layout follows my preferred [split 3x6 + 3 thumb
4-
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout with a few changes.
3+
This split ergo keyboard features 4x6 columnar-staggered keys and 4 thumb keys
4+
per side.
55

66
<details>
77
<summary>Layout notes</summary>
88

9+
* Based on [split 3x6+3](/layouts/split_3x6_3/bcat) layout. See that page for
10+
detailed rationale on keymap design.
911
* There's an optional number row at the top of the keyboard. I am quite used to
1012
using layers for numbers and symbols, so in practice this goes unused.
1113
* The dedicated Hyphen/Underscore and Equals/Plus keys on the number row are

‎keyboards/yanghu/unicorne/keymaps/bcat/README.md‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
# bcat's Unicorne layout
22

3-
This ergo layout follows my preferred [split 3x6 + 3 thumb
4-
keys](/layouts/split_3x6_3/bcat) layout, adding bindings for the two rotary
5-
encoders on the bottom row. (The left encoder scrolls vertically and the right
6-
encoder adjusts volume.) Also, since the Unicorne keyboard has a speaker, I
7-
added bindings on the adjust layer to activate and configure music mode.
8-
Finally, an adorable unicorn prances on the OLED, running faster the quicker you
9-
type.
3+
The [Unicorne](https://github.com/yanghu/unicorne) keyboard is an un-split Crkbd
4+
with slightly altered columbar stagger and two extra thumb keys (including
5+
rotary encoder compatibility).
6+
7+
<details>
8+
<summary>Layout notes</summary>
9+
10+
* Based on [split 3x6+3](/layouts/split_3x6_3/bcat) layout. See that page for
11+
detailed rationale on keymap design.
12+
* I built my Unicorne with rotary encoders: The left scrolls vertically and the
13+
right adjusts volume. These were a fun gimmick at first, but in retrospect,
14+
I'd prefer to use that as Alt and Super keys instead.
15+
* Since the Unicorne has a speaker, I added bindings on the Adjust layer to
16+
activate and configure QMK's [music
17+
mode](https://docs.qmk.fm/features/audio#music-mode).
18+
* Finally, an adorable unicorn prances on the OLED, running faster the quicker
19+
you type.
20+
</details>
1021

1122
| Default layer ([KLE](http://www.keyboard-layout-editor.com/#/gists/b6d0b16a913e7d1faeafc9fc751c413f)) |
1223
| :-: |

‎layouts/60_ansi_split_bs_rshift/bcat/README.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
# bcat's 60% ANSI layout with split Backspace and Right Shift
1+
# bcat's 60% ANSI (split Backspace, Right Shift) layout
22

33
This layout features an HHKB-style split Backspace and Right Shift together with
44
a standard ANSI bottom row. It's not my favorite layout, but can be useful when
5-
used with a keycap set that only includes a 6.25u spacebar. This keymap is
6-
configured identically to my preferred [Tsangan
7-
layout](/layouts/60_tsangan_hhkb/bcat), with the additional bottom row position
8-
mapped to the Menu key.
5+
a keycap set only includes a 6.25u spacebar.
6+
7+
<details>
8+
<summary>Layout notes</summary>
9+
10+
* Based on [60% Tsangan](/layouts/60_ansi_tsangan_split_bs_rshift) layout. See
11+
that page for detailed rationale on keymap design.
12+
* The additional bottom row position is mapped to the Menu key.
13+
</details>
914

1015
| Default layer ([KLE](http://www.keyboard-layout-editor.com/#/gists/327b41b5a933b3d44bf60ca9822e85dc)) |
1116
| :-: |

‎layouts/60_ansi_tsangan_split_bs_rshift/bcat/README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# bcat's 60% ANSI Tsangan layout with split Backspace and Right Shift
1+
# bcat's 60% ANSI Tsangan (split Backspace, Right Shift) layout
22

3-
This is a Tsangan/HHKB (split Backspace, split Right Shift) layout based on the
4-
[traditional HHKB layout](https://hhkb.io/layout/) with some custom [DIP
5-
switch](https://hhkb.io/components/controllers/) settings and a few more tweaks.
3+
This is a Tsangan layout based on the [HHKB layout](https://hhkb.io/layout/)
4+
with some [DIP switch](https://hhkb.io/components/controllers/) setting changes,
5+
plus a few more tweaks. (I use this layout with both standard 60% cases and ones
6+
with HHKB blockers.)
67

78
<details>
89
<summary>Layout notes</summary>

‎layouts/65_ansi_blocker_split_bs/bcat/README.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
# bcat's 65% ANSI layout with blocker and split Backspace
1+
# bcat's 65% ANSI (blocker and split Backspace) layout
22

33
This is a standard 65% keyboard layout, with a blocker to the left of the arrow
44
keys and an HHKB-style (split) Backspace.
55

6+
<details>
7+
<summary>Layout notes</summary>
8+
9+
* Based on [60% Tsangan](/layouts/60_ansi_tsangan_split_bs_rshift) layout. See
10+
that page for detailed rationale on keymap design.
11+
* The bottom row is laid out more like a traditional TKL keyboard, with the
12+
Super key on the left and a single Fn key on the right.
13+
* Dedicated arrow and navigation keys replace the HHKB diamond cluster (which
14+
I've since grown to prefer).
15+
</details>
16+
617
| Default layer ([KLE](http://www.keyboard-layout-editor.com/#/gists/dd675b40cc4df2c7bb78847ac29f5988)) |
718
| :-: |
819
| ![Layout](layer_default.png) |

‎layouts/split_3x6_3/bcat/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# bcat's 3x6+3 split layout
1+
# bcat's split 3x6+3 layout
22

3-
This is my preferred split ergo layout for typing. It is loosely inspired by the
4-
default Planck (symbols on Lower, numbers on Raise) and Crkbd (Space on left,
5-
Enter on right) layouts, but has since been redesigned heavily according to the
3+
This is my preferred split ergo layout. It was loosely inspired by the default
4+
Planck (symbols on Lower, numbers on Raise) and Crkbd (Space on left, Enter on
5+
right) layouts, but was subsequently modified heavily according to the
66
principles described below.
77

88
<details>

0 commit comments

Comments
 (0)