From 73fc56622f186872660b3e48ce91e0d04cf0f629 Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Sun, 14 Nov 2021 19:05:33 +1100 Subject: [PATCH] Update welcome.org --- welcome.org | 59 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 48 insertions(+), 11 deletions(-) diff --git a/welcome.org b/welcome.org index ede2983..f7b10ad 100644 --- a/welcome.org +++ b/welcome.org @@ -3,19 +3,44 @@ * Welcome -Welcome to the Miryoku ZMK alpha! +Welcome to the Miryoku ZMK private beta! *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/. +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 [[https://github.com/manna-harbour/zmk-config/blob/ab7d36ed911589735f341d2754bde7987f617b7e/.github/workflows/build-example-corne-nice_nano.yml#L9][this line]] to match the name of your private fork. This will not be necessary for forks of the public release. + + ** Todo -The keymap can be used now, but there's still some work needed before release. +Everything can be used now, but there's still some work needed before public release. *** +Miryoku documentation+ @@ -27,19 +52,31 @@ Miryoku documentation is now at https://github.com/manna-harbour/miryoku. +Code generation in Miryoku QMK and Miryoku ZMK is being combined into Miryoku Babel. At the moment the Miryoku ZMK keymap is generated from [[miryoku/miryoku-zmk-babel.org]]. Refer to the documentation in Miryoku QMK.+ -Miryoku Babel is now being used. +[[https://github.com/manna-harbour/miryoku_babel][Miryoku Babel]] is now being used. -*** Add new keyboard control layers -At the moment bluetooth is in the media layer. See [[miryoku/miryoku-zmk-babel.org#media-medr]]. +*** +Add ZMK mouse keys+ -*** Add ZMK mouse keys -There is a ~mousekeys~ branch with the [[https://github.com/zmkfirmware/zmk/pull/778][mousekeys PR]] enabled and configured. Use ~CONFIG_ZMK_MOUSE=y~ in Kconfig [[https://github.com/zmkfirmware/zmk/blob/e91fb88eadc8593f430ea04c5f4e11102176eb94/docs/docs/behaviors/mouse-emulation.md][as described]]. +**** Default Branch -In the default branch the mouse layer is using mouse keys on the host. +In the default branch the Mouse layer is using mouse keys on the host. - X11: https://en.wikipedia.org/wiki/Mouse_keys - Windows: https://support.microsoft.com/en-us/windows/use-mouse-keys-to-move-the-mouse-pointer-9e0c72c8-b882-7918-8e7b-391fd62adf33 - Mac: https://support.apple.com/en-au/guide/mac-help/mh27469/mac + +**** mousekeys Branch + +There is a ~mousekeys~ branch with the [[https://github.com/zmkfirmware/zmk/pull/778][mousekeys PR]] enabled and configured. Use ~CONFIG_ZMK_MOUSE=y~ in Kconfig [[https://github.com/zmkfirmware/zmk/blob/e91fb88eadc8593f430ea04c5f4e11102176eb94/docs/docs/behaviors/mouse-emulation.md][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. + + +** + +[[https://github.com/manna-harbour][https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png]]