Skip to content

Commit

Permalink
Reformat keymap READMEs for easy reading
Browse files Browse the repository at this point in the history
  • Loading branch information
bcat committed Jan 13, 2024
1 parent 2830e8e commit 3753051
Show file tree
Hide file tree
Showing 8 changed files with 147 additions and 120 deletions.
50 changes: 27 additions & 23 deletions keyboards/eco/keymaps/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,50 @@

This is a cute little 4x14 ortholinear keyboard. I've set it up using an
unsplit, ortho version of my [split 3x6 + 3 thumb
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout, with the following changes:

* The alpha keys are separated by an extra two columns in the middle to provide
a little more hand separation, similar to a split keyboard.

* The top three rows of the extra middle columns feature navigation keys and
brackets/braces. I don't really use dedicated keys for these, but I had the
keycaps, so I figured I may as well put them there.

* I have a Left Alt and Right Super key on the bottom row just like my
[Lily58](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lily58/keymaps/bcat).

* The two keys in each bottom corner are unbound, as is the 2U spacebar in the
center of the bottom row. These keys are too inconvenient to reach, and
there's nothing really useful to bind them to anyway.
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout with a few tweaks.

## Default layer

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/2c11371c7a5f7cd08a0132631d3d3281))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/2c11371c7a5f7cd08a0132631d3d3281)

## Lower layer

![Layout](layer_lower.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/11256970dc0552886a82382ee02fa415))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/11256970dc0552886a82382ee02fa415)

## Raise layer

![Layout](layer_raise.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/308a8be75e0b85902dc18db1b2546862))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/308a8be75e0b85902dc18db1b2546862)

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/b18aafa0327d7e83eaf485546c067a21))
* Activated by holding the Lower and Raise keys simultaneously.

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/b18aafa0327d7e83eaf485546c067a21)

## Notes

* The alpha keys are separated by an extra two columns in the middle to provide
a little more hand separation, similar to a split keyboard.

* The top three rows of the extra middle columns feature navigation keys and
brackets/braces. I don't really use dedicated keys for these, but I had the
keycaps, so I figured I may as well put them there.

* I have a Left Alt and Right Super key on the bottom row just like my
[Lily58](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lily58/keymaps/bcat).

* The two keys in each bottom corner are unbound, as is the 2U spacebar in the
center of the bottom row. These keys are too inconvenient to reach, and
there's nothing really useful to bind them to anyway.
14 changes: 8 additions & 6 deletions keyboards/keebio/quefrency/keymaps/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@ ESDF cluster), and RGB controls in the adjust layer (on the arrow/nav keys).

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/60a262432bb340b37d364a4424f3037b))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/60a262432bb340b37d364a4424f3037b)

## Function layer

![Layout](layer_function.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/59636898946da51f91fb290f8e078b4d))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/59636898946da51f91fb290f8e078b4d)

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/ffc2064d6b2f6a4721a3a4c6124e4ea8))
* Activated by holding the Left Fn and Right Fn keys simultaneously.

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/ffc2064d6b2f6a4721a3a4c6124e4ea8)
48 changes: 26 additions & 22 deletions keyboards/lily58/keymaps/bcat/readme.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
# bcat's Lily58 layout

This split ergo layout follows my preferred [split 3x6 + 3 thumb
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout with a few changes:

* There's an optional number row at the top of the keyboard. I am quite used to
using layers for numbers and symbols, so in practice this goes unused.

* The dedicated Hyphen/Underscore and Equals/Plus keys on the number row are
placed in the same positions as on the ErgoDox EZ. (There's no real reason for
this; I just had to do _something_ with those keys.)

* The extra thumb keys on the bottom row are used for a Left Alt key (for easier
Alt+Tab, Alt+F4, etc.) and a dedicated Super key.

* The harder-to-reach thumb keys below the controllers are bound to browser
back/forward navigation keys.
keys](/layouts/split_3x6_3/bcat) (Crkbd) layout with a few changes.

## Default layer

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/e0eb3af65961e9fd612dcff3ddd88e4f))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/e0eb3af65961e9fd612dcff3ddd88e4f)

## Lower layer

![Layout](layer_lower.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/19ad0d3b5d745fbb2818db09740f5a11))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/19ad0d3b5d745fbb2818db09740f5a11)

## Raise layer

![Layout](layer_raise.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/912be7955f781cdaf692cc4d4c0b5823))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/912be7955f781cdaf692cc4d4c0b5823)

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/8f6a3f08350a9bbe1d414b22bca4e6c7))
* Activated by holding the Lower and Raise keys simultaneously.

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/8f6a3f08350a9bbe1d414b22bca4e6c7)

## Notes

* There's an optional number row at the top of the keyboard. I am quite used to
using layers for numbers and symbols, so in practice this goes unused.

* The dedicated Hyphen/Underscore and Equals/Plus keys on the number row are
placed in the same positions as on the ErgoDox EZ. (There's no real reason for
this; I just had to do _something_ with those keys.)

* The extra thumb keys on the bottom row are used for a Left Alt key (for easier
Alt+Tab, Alt+F4, etc.) and a dedicated Super key.

* The harder-to-reach thumb keys below the controllers are bound to browser
back/forward navigation keys.
16 changes: 8 additions & 8 deletions keyboards/yanghu/unicorne/keymaps/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,26 @@ type.

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/b6d0b16a913e7d1faeafc9fc751c413f))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/b6d0b16a913e7d1faeafc9fc751c413f)

## Lower layer

![Layout](layer_lower.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/99dd65d3b857a272be7a1804b20bc266))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/99dd65d3b857a272be7a1804b20bc266)

## Raise layer

![Layout](layer_raise.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/cf9e899867763dc45b65917ce4cf93ff))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/cf9e899867763dc45b65917ce4cf93ff)

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/7eb0f1c437169f30cc18eac271ad2302))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/7eb0f1c437169f30cc18eac271ad2302)
14 changes: 8 additions & 6 deletions layouts/60_ansi_split_bs_rshift/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,21 @@ mapped to the Menu key.

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/327b41b5a933b3d44bf60ca9822e85dc))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/327b41b5a933b3d44bf60ca9822e85dc)

## Function layer

![Layout](layer_function.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/c7a55e75285d474b6301140eaf53f915))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/c7a55e75285d474b6301140eaf53f915)

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/6e1068e4f91bbacccaf5ac0acbeec79c))
* Activated by holding the Left Fn and Right Fn keys simultaneously.

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/6e1068e4f91bbacccaf5ac0acbeec79c)
46 changes: 25 additions & 21 deletions layouts/60_tsangan_hhkb/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,31 @@ This is a Tsangan/HHKB (split Backspace, split Right Shift) layout based on the
[traditional HHKB layout](https://hhkb.io/layout/) with some custom [DIP
switch](https://hhkb.io/components/controllers/) settings and a few more tweaks:

## Default layer

![Layout](layer_default.png)

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/86b33d75aa6f56d8781ab3d8475f4e77)

## Function layer

![Layout](layer_function.png)

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/f6311fd7e315de781143b80eb040a551)

## Adjust layer

![Layout](layer_adjust.png)

* Activated by holding the Left Fn and Right Fn keys simultaneously.

* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/65ac939caec878401603bc36290852d4)

## Notes

* The Delete key is mapped as Backspace (SW3).

* The Alt and Super keys are swapped to put Alt directly adjacent to the
Expand All @@ -27,24 +52,3 @@ switch](https://hhkb.io/components/controllers/) settings and a few more tweaks:
anything more useful because many of my Tsangan PCBs have HHKB-layout plates
and/or blockers, and so it's not even guaranteed there are switches installed
in these positions.

## Default layer

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/86b33d75aa6f56d8781ab3d8475f4e77))

## Function layer

![Layout](layer_function.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/f6311fd7e315de781143b80eb040a551))

## Adjust layer

![Layout](layer_adjust.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/65ac939caec878401603bc36290852d4))
8 changes: 4 additions & 4 deletions layouts/65_ansi_blocker_split_bs/bcat/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ keys, an HHKB-style (split) Backspace, and media controls in the function layer

![Layout](layer_default.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/dd675b40cc4df2c7bb78847ac29f5988))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/dd675b40cc4df2c7bb78847ac29f5988)

## Function layer

![Layout](layer_function.png)

([Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/f29128427f674c43777f045e363d1b44))
* [Keyboard Layout
Editor](http://www.keyboard-layout-editor.com/#/gists/f29128427f674c43777f045e363d1b44)
Loading

0 comments on commit 3753051

Please sign in to comment.