ClaytonWWilson/miryoku_zmk
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-13 17:58:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update mousekeys PR docs and workflow

Browse Source
This commit is contained in:
Manna Harbour 2022-09-24 18:06:36 +10:00
parent 2dec2451a1
commit 17d20c5404
2 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/workflows/build-example-mousekeyspr.yml vendored
View File

@ -12,8 +12,4 @@ jobs:
shield: '["corne_left"]' shield: '["corne_left"]'
custom_config: '["#define MIRYOKU_KLUDGE_MOUSEKEYSPR"]' custom_config: '["#define MIRYOKU_KLUDGE_MOUSEKEYSPR"]'
kconfig: '["CONFIG_ZMK_MOUSE=y"]' kconfig: '["CONFIG_ZMK_MOUSE=y"]'
branches: '[ branches: '["zmkfirmware/zmk/main ftc/zmk/mouse-ftc"]'
"zmkfirmware/zmk/main krikun98/zmk/mouse-pr",
"zmkfirmware/zmk/main ftc/zmk/mouse-ftc",
"ftc/zmk/mouse-ftc"
]'

8
readme.org
View File

@ -438,13 +438,11 @@ The Mouse and Button layers use [[https://en.wikipedia.org/wiki/Mouse_keys][mous
Support for https://github.com/zmkfirmware/zmk/pull/778 is also included. Support for https://github.com/zmkfirmware/zmk/pull/778 is also included.
Add ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ to the [[#config-file][config file]]. As the PR branch is not being maintained, use https://github.com/ftc/zmk/tree/mouse-ftc instead.
Add ~CONFIG_ZMK_MOUSE=y~ to the [[#kconfig-configuration][Kconfig configuration]]. To build, add ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ to the [[#config-file][config file]], add ~CONFIG_ZMK_MOUSE=y~ to the [[#kconfig-configuration][Kconfig configuration]], and merge the mousekeys branch.
Merge the mousekeys PR branch. For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ with the ~custom_config~ option, ~CONFIG_ZMK_MOUSE=y~ with the ~kconfig~ option, and ~zmkfirmware/zmk/main ftc/zmk/mouse-ftc~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-mousekeyspr.yml][Build Example mousekeyspr]] workflow.
For [[#workflow-builds][workflow builds]], the [[#build-inputs][Build Inputs]] workflow can be used. To specify the mousekeys PR [[#branches][branch]] use ~krikun98/zmk/mouse-pr~. For [[#build-examples][Build Example]] workflows see the [[.github/workflows/build-example-mousekeyspr.yml][Build Example mousekeyspr]] workflow. The Build Example workflow also includes suggested branches for when the mousekeys PR branch is out of date. If it is too far out of date it will need to be merged manually.
For local builds, make the changes locally. For local builds, make the changes locally.