ficd/zmk
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
urob 2024-12-17 00:27:58 -05:00
parent ea0538ffba
commit a0f1b1a5a2
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
readme.md
View file

@ -4,9 +4,10 @@ This is my personal [ZMK firmware](https://github.com/zmkfirmware/zmk/)
configuration. It consists of a 34-keys base layout that is re-used for various configuration. It consists of a 34-keys base layout that is re-used for various
boards, including my Corneish Zen and my Planck. boards, including my Corneish Zen and my Planck.
This branch is updated for the latest ZMK using Zephyr 3.5. A legacy version My configuration builds against `v0.1` of upstream ZMK plus a backport of the
compatible with Zephyr 3.0 is available merged pointer PR. Custom functionality is added through various ZMK modules.
[here](https://github.com/urob/zmk-config/tree/main-zephyr-3.0). The state of the entire firmware is pinned in my `west`
[manifest](https://github.com/urob/zmk-config/blob/main/config/west.yml).
## Highlights ## Highlights
@ -245,13 +246,12 @@ one-handed Alt-Tab switcher (`PWin` and `NWin`).
##### Leader key ##### Leader key
I recently started using Nick Conway's I am using my own implementation of a
[Leader key](https://github.com/zmkfirmware/zmk/pull/1380) implementation for [Leader key](https://github.com/urob/zmk-leader-key) to bind less common
ZMK. From my limited experience, I really like how it allows making less functionality without giving up dedicated keys. Currently, I am using leader
commonly used behaviors accessible without binding them to a dedicated key. For sequences for various system and output controls. I am also using leader key
now I am using it for a variety of Unicode math symbols and international sequences for convenient access to various Unicode math symbols and
characters. I am planning to extend the use to various firmware interactions international characters.
once I figure out the technical details.
## Local development workspace ## Local development workspace
@ -403,8 +403,8 @@ remaining issues:
([#544](https://github.com/zmkfirmware/zmk/issues/544)), requiring a brief ([#544](https://github.com/zmkfirmware/zmk/issues/544)), requiring a brief
pause when wanting to chord HRMs that overlap with combo positions. As a pause when wanting to chord HRMs that overlap with combo positions. As a
workaround, I implemented all homerow combos as homerow-mod-combos. This is workaround, I implemented all homerow combos as homerow-mod-combos. This is
good enough for day-to-day, but does not address all edge cases (eg good enough for day-to-day, but does not address all edge cases (eg changing
changing active mods). active mods).
- Very minor: `&bootloader` doesn't work with stm32 boards like the Planck - Very minor: `&bootloader` doesn't work with stm32 boards like the Planck
([#1086](https://github.com/zmkfirmware/zmk/issues/1086)) ([#1086](https://github.com/zmkfirmware/zmk/issues/1086))