3.6 KiB
Welcome
Welcome to the Miryoku ZMK private beta!
Please don't redistribute. If you fork, please make the fork private.
See the notes below, then see the main readme at https://github.com/manna-harbour/zmk-config/.
Please let me know if you have any issues.
Caveats
Collaborator Access
You've been added as a collaborator to the repository in order to give access. There's no branch protection so please take care when pushing.
You're welcome to make personal branches. Please name them starting with your username.
Please note that collaborators will be removed from the private beta repository sometime after the public release.
Repository Location
The public release will be at https://github.com/manna-harbour/miryoku_zmk/ and will be linked from https://github.com/manna-harbour/miryoku.
There may be some links in the readme already pointing to the public repository and they will be broken until release.
Github Actions Workflows
From the public repository a fork will be required to access the workflows, but as you have access to the private beta repository you can use the workflows there directly without forking.
The workflows are implemented with reusable workflows. As such, absolute URLs for the called workflow are required in the calling workflow, and for private repositories the called workflow is required to be located in the same repository. So, in order to use the workflows in a private fork of the private beta repository you will need to edit the called workflow URL in the calling workflow files. E.g. edit this line to match the name of your private fork. This will not be necessary for forks of the public release.
Todo
Everything can be used now, but there's still some work needed before public 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.
Miryoku documentation is now at https://github.com/manna-harbour/miryoku.
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/d485ed68120d9b9afe842ae9b6617e38640ade65/miryoku/miryoku-zmk-babel.org. Refer to the documentation in Miryoku QMK.
Miryoku Babel is now being used.
Add ZMK mouse keys
Default Branch
In the default branch the Mouse layer is using mouse keys on the host.
mousekeys Branch
There is a mousekeys branch with the mousekeys PR enabled and configured. Use CONFIG_ZMK_MOUSE=y in Kconfig as described.
Add new keyboard control layers
At the moment bluetooth is in the Media layer. For locations, see https://github.com/manna-harbour/miryoku_babel#media, https://github.com/manna-harbour/miryoku_babel#vi-style, or https://github.com/manna-harbour/miryoku_babel#inverted-t, as appropriate.
