Skip to content

Commit

Permalink
Readme and more fun
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewtodd committed Nov 30, 2024
1 parent 0895328 commit 1eff234
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
This is the thoughtful [Miryoku](https://github.com/manna-harbour/miryoku)
layout, copied into my own config repo so I can play around a little more
easily.
# ⌨️ ZMK Config

![keymap](docs/cradio.svg)
I've been using a wireless [Ferris Sweep][sweep] from
[Boardsource][boardsource] with [Ambients switches][ambients] since Spring
2024. I love it!

This repository holds its firmware configuration. I had initially
[tweaked][tweaked] the thoughtful [Miryoku][miryoku] layout and used that quite
happily. Now I am inlining it all here so it'll be easier for me to tinker
with.

I have primarily removed some Miryoku features I wasn't using and
experimentally added the [Sturdy][sturdy] keyboard layout as an alternate
layer, to see what I think of it. Future work may include a QWERTY alternate
layer so I can let friends test-drive the keyboard more easily, as well as
exploration of non-momentary layer changes, since my thumbs get a little
fatigued holding layer switches down.

## Layout

![keymap][keymap]

[sweep]: https://github.com/davidphilipbarr/Sweep
[boardsource]: https://www.boardsource.xyz/products/crab-broom
[ambients]: https://lowprokb.ca/collections/switches/products/ambients-silent-choc-switches?variant=44873446391972
[tweaked]: https://github.com/manna-harbour/miryoku_zmk/compare/master...matthewtodd:miryoku_zmk:matthewtodd
[miryoku]: https://github.com/manna-harbour/miryoku
[sturdy]: https://oxey.dev/sturdy
[keymap]: docs/cradio.svg
3 changes: 2 additions & 1 deletion docs/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
draw_config:
append_colon_to_layer_header: false
dark_mode: auto

parse_config:
Expand All @@ -9,7 +10,7 @@ parse_config:
media: "Media"
number: "Num"
symbol: "Sym"
function: "Func"
function: "Fun"
sturdy_number: "Sturdy Number Overrides"
sturdy_symbol: "Sturdy Symbol Overrides"

Expand Down

0 comments on commit 1eff234

Please sign in to comment.