Add unicode details to readme

This commit is contained in:
urob 2022-06-22 21:52:41 -04:00
parent c5b3dea91c
commit d04669c914

View file

@ -12,7 +12,7 @@ It is ported from my QMK configuration, which in turn is heavily inspired by Man
- most symbols can be accessed from the base layer via combos - most symbols can be accessed from the base layer via combos
- sticky shift on right thumb, double-tap activates caps-word - sticky shift on right thumb, double-tap activates caps-word
- backspace morphs into delete when shifted - backspace morphs into delete when shifted
- unicode layer with Greek letters for mathematical typesetting (not yet ported to ZMK) - unicode layer with Greek letters for mathematical typesetting (implemented via preprocessor macros[^2])
![](img/keymap.png) ![](img/keymap.png)
@ -27,11 +27,12 @@ and (2) make them easy to remember. Specifically:
(subscript `_` aligns with superscript `^`; minus `-` aligns with `+`; division `/` (subscript `_` aligns with superscript `^`; minus `-` aligns with `+`; division `/`
aligns with multiplication `*`; logical-or `|` aligns with logical-and `&`; backslash aligns with multiplication `*`; logical-or `|` aligns with logical-and `&`; backslash
`\` aligns horizontally with forward slash `/`) `\` aligns horizontally with forward slash `/`)
- parenthesis, brackets, braces and punctuation are on the right-hand side for easy - `!` and `?` are on home-row position for prime access
usage when typing numbers - parenthesis, brackets and braces are on the right-hand side for easy access when
typing numbers
- a numlock shortcut (on `W + P`) is on the left-hand side for one-handed number-mode - a numlock shortcut (on `W + P`) is on the left-hand side for one-handed number-mode
- shortcuts for cut (on `X + D`), copy, and paste are on the left-hand side for - shortcuts for cut (on `X + D`), copy, and paste are on the left-hand side for
one-handed usage when using the mouse one-handed usage when working with the mouse
[^1]: I use a 36-key layout per default. Additional thumb keys can be configured with [^1]: I use a 36-key layout per default. Additional thumb keys can be configured with
the `EXTRA_BOT_L` and `EXTRA_BOT_R` macros. Additional "middle-keys" can be the `EXTRA_BOT_L` and `EXTRA_BOT_R` macros. Additional "middle-keys" can be
@ -45,3 +46,8 @@ and (2) make them easy to remember. Specifically:
first key on the **L**eft **T**op-row and ranging to `RB4` for the last key on the first key on the **L**eft **T**op-row and ranging to `RB4` for the last key on the
**R**ight **B**ottom-row. They need to be defined in the shield-specific keymap-file **R**ight **B**ottom-row. They need to be defined in the shield-specific keymap-file
*before* sourcing the common `base.keymap`. *before* sourcing the common `base.keymap`.
[^2]: This is my attempt at a simple user-space solution until unicode is natively
supported. Check out `unicode.dtsi` for details and read
[my write up here](https://github.com/zmkfirmware/zmk/issues/232#issuecomment-1163833880)
for a few more pointers and some caveats.