Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bsag committed Dec 3, 2023
1 parent 469743a commit 8318383
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

<figure>
<img src="./keymap.svg" alt="Miryoku inspired keymap for TOTEM keyboard, showing all six layers" width="100%" />
<figcaption>Keyboard layout for all layers</figcaption>
<figcaption>Keyboard layout for all layers and combos</figcaption>
</figure>

This is a ZMK firmware for a [TOTEM keyboard](https://github.com/GEIGEIGEIST/TOTEM), using a keymap that is pretty much copied from the great [Miryoku layout](https://github.com/manna-harbour/miryoku_zmk#caps-word). I could have used Miryoku directly of course, but I have settled on the features I enjoy from it so can hard code them, rather than needing flexibility, and I prefer my homerow mods to be Shift, Super, Alt, Ctrl (from the index finger to the pinky), rather than Super and Ctrl being swapped as they are in Miryoku ZMK.
This is a ZMK firmware for a [TOTEM keyboard](https://github.com/GEIGEIGEIST/TOTEM), using a keymap that is pretty much copied from both the great [Miryoku layout](https://github.com/manna-harbour/miryoku_zmk#caps-word), and [urob's ZMK config](https://github.com/urob/zmk-config/tree/main). I use the alternate hand layout of most of the layers (so that the layer key and modifiers are on one hand, and the main keys of that layout on the other), but combine that with urob's idea of having symbols as combos. I have also adopted his "Timer-less home row mods", which work really well and avoid the usual drawbacks of home row mods.

I have added one or two things that are useful to me:
Caps word is activated by tapping both home row index finger keys, and as I find it easier to have a dedicated shift key for capitalising words, I have a one-shot shift key on the inner left thumb key, and use that for capitalisation and the home row shift for keyboard shortcut combos.

- Combo for caps word on homerow shift keys
- Combo for left and right parens on the middle/bottom row middle finger keys, to make parens more accessible for ordinary typing
- Tab forward/back (default layer), back/forward (nav layer), and angle brackets (num and sym layers) on the extra pinkie keys, to give these useful keys a dedicated home. The angle brackets are otherwise a bit awkward to access for R symbols like `<-`.
Having all the mods in the home row makes it pretty easy to mash a bunch of them to get Hyper (Shift + Command + Option + Control) or Meh (Shift + Option + Control), but --- just because I can --- I have the index and middle finger keys on the bottom row as Hyper and Meh mod taps too. That makes it very easy to create useful keyboard shortcuts for global OS use without any fear of clashes.

Finally, the extra outer pinky key is used for previous/next tab, back/forward in navigation history, and parens in the number layer. I tend not to hit those keys accidentally as they are way out there, but it is useful to have dedicated and spatially organised keys for common navigation stuff.

0 comments on commit 8318383

Please sign in to comment.