Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewtodd committed Dec 26, 2024
1 parent 3d83c9f commit 06a7a38
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ can tinker a little more freely.
- Removed [additional features][miryoku-additional-features] (boot, base, tap,
extra, opposite, current).
- Removed keys I didn't use (insert, RGB, power & output toggles, scroll lock).
- Added a layer for the [Sturdy][sturdy] keyboard layout! Colemak-DH is a very
sensible default, but I'm curious what I might learn from other experimental
layouts like this.
- Added a QWERTY layer so friends can test-drive the keyboard more easily.
- Added layers for a bunch of alternative keyboard layouts! Colemak-DH is a very
sensible default, but after scanning [Pascal Getreuer's guide][which-alt], I'm
hoping I might find one I like well enough to switch. I'm currently trying out
[Sturdy][sturdy], [Canary][canary], [Gallium][gallium], and [Focal][focal].
- Added a Qwerty layer so friends can test-drive the keyboard more easily.

## Things I might try someday

Expand All @@ -32,6 +33,8 @@ can tinker a little more freely.

## What the layers look like

Thanks to [caksoylar/keymap-drawer][keymap-drawer].

![keymap][keymap]

[ferris-sweep]: https://github.com/davidphilipbarr/Sweep
Expand All @@ -42,4 +45,9 @@ can tinker a little more freely.
[miryoku-button-layer]: https://github.com/manna-harbour/miryoku/tree/master/docs/reference#button
[miryoku-additional-features]: https://github.com/manna-harbour/miryoku/tree/master/docs/reference#additional-features
[sturdy]: https://oxey.dev/sturdy
[canary]: https://github.com/Apsu/Canary
[gallium]: https://github.com/GalileoBlues/Gallium
[focal]: https://github.com/Keyhabit/Focal-keyboard-layout/
[which-alt]: https://getreuer.info/posts/keyboards/alt-layouts/index.html#which-alt-keyboard-layout-should-i-learn
[keymap-drawer]: https://github.com/caksoylar/keymap-drawer
[keymap]: docs/cradio.svg
15 changes: 12 additions & 3 deletions docs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ draw_config:

parse_config:
layer_legend_map:
colemak_dh: "Colemak-DH"
sturdy: "Sturdy"
qwerty: "QWERTY"
nav: "Nav"
mouse: "Mouse"
media: "Media"
number: "Num"
symbol: "Sym"
Expand All @@ -17,6 +15,17 @@ parse_config:

raw_binding_map:
"&caps_word": "Caps"
"&mmv MOVE_LEFT": $$mdi:arrow-left-thick$$
"&mmv MOVE_DOWN": $$mdi:arrow-down-thick$$
"&mmv MOVE_UP": $$mdi:arrow-up-thick$$
"&mmv MOVE_RIGHT": $$mdi:arrow-right-thick$$
"&msc SCRL_LEFT": $$mdi:arrow-right-bold-outline$$
"&msc SCRL_DOWN": $$mdi:arrow-up-bold-outline$$
"&msc SCRL_UP": $$mdi:arrow-down-bold-outline$$
"&msc SCRL_RIGHT": $$mdi:arrow-left-bold-outline$$
"&mkp LCLK": Left
"&mkp RCLK": Right


zmk_keycode_map:
EXCL: "!"
Expand Down

0 comments on commit 06a7a38

Please sign in to comment.