Skip to content

Commit

Permalink
Update branches docs and build examples
Browse files Browse the repository at this point in the history
- Use branch directly by default
- Attempt automatic merge if desired
  - If conflicts
    - Build from branch directly
    - Request rebase from maintainer
  • Loading branch information
manna-harbour committed Feb 27, 2024
1 parent b5511ba commit 17a6687
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 14 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build-example-mousekeyspr.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2023 Manna Harbour
# Copyright 2024 Manna Harbour
# https://github.com/manna-harbour/miryoku

name: 'Build Example mousekeyspr'
Expand All @@ -11,4 +11,4 @@ jobs:
board: '["nice_nano"]'
shield: '["corne_left"]'
custom_config: '["#define MIRYOKU_KLUDGE_MOUSEKEYSPR"]'
branches: '["zmkfirmware/zmk/main caksoylar/zmk/feat/mouse-keys-3.2"]'
branches: '["caksoylar/zmk/feat/mouse-keys-3.2","zmkfirmware/zmk/main caksoylar/zmk/feat/mouse-keys-3.2"]'
2 changes: 1 addition & 1 deletion .github/workflows/build-example-suspend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
board: '["nice_nano"]'
shield: '["corne_left","corne_right"]'
custom_config: '["#define MIRYOKU_KLUDGE_SUSPEND"]'
branches: '["zmkfirmware/zmk/main manna-harbour/zmk/suspend-test"]'
branches: '["manna-harbour/zmk/suspend-test","zmkfirmware/zmk/main manna-harbour/zmk/suspend-test"]'
2 changes: 1 addition & 1 deletion .github/workflows/build-example-xmk-native_posix_64.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ jobs:
with:
board: '["native_posix_64"]'
custom_config: '["#define MIRYOKU_KLUDGE_TAPDELAY"]'
branches: '["zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command"]'
branches: '["petejohanson/zmk/shell/tap-command","zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command"]'
2 changes: 1 addition & 1 deletion .github/workflows/build-example-xmk-xmk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ jobs:
with:
board: '["nice_nano_v2"]'
shield: '["xmk"]'
branches: '["zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command"]'
branches: '["petejohanson/zmk/shell/tap-command","zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command"]'
26 changes: 17 additions & 9 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Used to select an alternative ZMK branch for building, and to merge branches int

Branches are specified in the form ~<user>/<repo>/<branch>~. E.g. the default ZMK branch would be specified as ~zmkfirmware/zmk/main~.

Multiple space separated branches can be specified. The first branch specified is used as an alternative ZMK branch for building. Any additional branches will be merged.
Multiple space separated branches can be specified. The first branch specified is used as an alternative ZMK branch for building. Any additional branches will be merged. Automatic merging is only possible where there are no conflicts. If there are conflicts, build from the branch directly, or request a rebase from the branch maintainer.

For no changes, leave as ~default~.

Expand Down Expand Up @@ -490,9 +490,11 @@ Mouse movement requires [[https://en.wikipedia.org/wiki/Mouse_keys][enabling mou

Mouse movement and scroll is supported with https://github.com/caksoylar/zmk/tree/feat/mouse-keys-3.2.

To build, add ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ to the [[#config-file][config file]], and merge the mousekeys branch.
To build, add ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ to the [[#config-file][config file]], and switch to or merge the mousekeys branch.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ with the ~custom_config~ option, and ~zmkfirmware/zmk/main caksoylar/zmk/feat/mouse-keys-3.2~ 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]] using the [[#build-inputs][Build Inputs]] workflow, use ~#define MIRYOKU_KLUDGE_MOUSEKEYSPR~ with the ~custom_config~ option, and ~caksoylar/zmk/feat/mouse-keys-3.2~ with the ~branches~ option. Alternatively, use ~zmkfirmware/zmk/main caksoylar/zmk/feat/mouse-keys-3.2~ to attempt an automatic [[#branches][merge]] of the branch into ZMK main.

For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-mousekeyspr.yml][Build Example mousekeyspr]] workflow.

For local builds, make the changes locally.

Expand All @@ -503,9 +505,11 @@ Support for https://github.com/zmkfirmware/zmk/issues/1292#issuecomment-12646035

Suspend takes the place of the [[https://github.com/manna-harbour/miryoku/tree/master/docs/reference#additional-features][boot]] key. For split keyboards, suspend the peripheral side then the central side.

For [[#local-builds][local builds]], add ~#define MIRYOKU_KLUDGE_SUSPEND~ to the [[#config-file][config file]] and merge https://github.com/manna-harbour/zmk/tree/suspend-test.
For [[#local-builds][local builds]], add ~#define MIRYOKU_KLUDGE_SUSPEND~ to the [[#config-file][config file]] and switch to or merge https://github.com/manna-harbour/zmk/tree/suspend-test.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~#define MIRYOKU_KLUDGE_SUSPEND~ with the ~custom_config~ option, and ~manna-harbour/zmk/suspend-test~ with the ~branches~ option. Alternatively, use ~zmkfirmware/zmk/main manna-harbour/zmk/suspend-test~ to attempt an automatic [[#branches][merge]] of the branch into ZMK main.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~#define MIRYOKU_KLUDGE_SUSPEND~ with the ~custom_config~ option, and ~zmkfirmware/zmk/main manna-harbour/zmk/suspend-test~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-suspend.yml][Build Example suspend]] workflow.
For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-suspend.yml][Build Example suspend]] workflow.


*** Tap Delay
Expand All @@ -522,16 +526,20 @@ Use Miryoku ZMK with any keyboard with [[https://github.com/manna-harbour/xmk][

**** xmk Shield

For [[#local-builds][local builds]] first merge https://github.com/zmkfirmware/zmk/pull/1318. Add https://github.com/manna-harbour/xmk/tree/main/zmk/boards/shields/xmk as ~config/boards/shields/xmk~. Build with shield ~xmk~ and the appropriate board.
For [[#local-builds][local builds]], first switch to or merge https://github.com/zmkfirmware/zmk/pull/1318. Add https://github.com/manna-harbour/xmk/tree/main/zmk/boards/shields/xmk as ~config/boards/shields/xmk~. Build with shield ~xmk~ and the appropriate board.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~xmk~ with the ~shield~ option, the appropriate board with the ~board~ option, and ~zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-xmk-xmk.yml][Build Example 𝑥MK xmk]] workflow.
For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~xmk~ with the ~shield~ option, the appropriate board with the ~board~ option, and ~petejohanson/zmk/shell/tap-command~ with the ~branches~ option. Alternatively, use ~zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command~ to attempt an automatic [[#branches][merge]] of the branch into ZMK main.

For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-xmk-xmk.yml][Build Example 𝑥MK xmk]] workflow.


**** native_posix_64 Board

For [[#local-builds][local builds]] first merge https://github.com/zmkfirmware/zmk/pull/1318. Add ~#define MIRYOKU_KLUDGE_TAPDELAY~ to the config file. Build with board ~native_posix_64~.
For [[#local-builds][local builds]], first switch to or merge https://github.com/zmkfirmware/zmk/pull/1318. Add ~#define MIRYOKU_KLUDGE_TAPDELAY~ to the config file. Build with board ~native_posix_64~.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~native_posix_64~ with the ~board~ option, ~#define MIRYOKU_KLUDGE_TAPDELAY~ with the ~custom_config~ option, and ~petejohanson/zmk/shell/tap-command~ with the ~branches~ option. Alternatively, use ~zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command~ to attempt an automatic [[#branches][merge]] of the branch into ZMK main.

For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~native_posix_64~ with the ~board~ option, ~#define MIRYOKU_KLUDGE_TAPDELAY~ with the ~custom_config~ option, and ~zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-xmk-native_posix_64.yml][Build Example 𝑥MK native_posix_64]] workflow.
For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-xmk-native_posix_64.yml][Build Example 𝑥MK native_posix_64]] workflow.


** Issues
Expand Down

0 comments on commit 17a6687

Please sign in to comment.