miryoku_zmk/welcome.org
2022-06-02 16:03:50 +10:00

1.8 KiB

Welcome

Welcome to the Miryoku ZMK alpha!

Please don't redistribute. If you fork, please make the fork private.

You've been added as a collaborator to the repo as it's the easiest way to give access. If you could avoid accidental force pushes to master that'd be great! You're not expected to contribute but contributions are of course welcome. In that case please create a new branch and PR.

See the Todo section below, then see https://github.com/manna-harbour/zmk-config/.

Please let me know if you have any issues.

Todo

The keymap can be used now, but there's still some work needed before release.

Miryoku documentation

Miryoku documentation is being moved from the Miryoku QMK repo to the Miryoku repo. For now, refer to the documentation in Miryoku QMK.

Miyroku Babel

Code generation in Miryoku QMK and Miryoku ZMK is being combined into Miryoku Babel. At the moment the Miryoku ZMK keymap is generated from /ClaytonWWilson/miryoku_zmk/src/commit/b2d25e0580c7c97180427ee22e2d48accbd7916f/miryoku/miryoku-zmk-babel.org. Refer to the documentation in Miryoku QMK.

Add new keyboard control layers

Add ZMK mouse keys

There is a mousekeys branch with the mousekeys PR enabled and configured. Use CONFIG_ZMK_MOUSE=y in Kconfig as described.

In the default branch the mouse layer is using mouse keys on the host.