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

Add MIRYOKU_KLUDGE_MOUSEKEYSPR docs and build example

Browse Source
This commit is contained in:
Manna Harbour 2022-04-05 17:13:44 +10:00
parent 4896aa8e55
commit 5a0a9e1b8f
2 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml vendored Normal file
View File

@ -0,0 +1,15 @@
# Copyright 2022 Manna Harbour
# https://github.com/manna-harbour/miryoku
name: 'Build Example corne nice_nano mousekeyspr'
on:
workflow_dispatch:
jobs:
build:
uses: manna-harbour/zmk-config/.github/workflows/main.yml@31a649e5571b4572d7010561dd3f191922cd9410
with:
board: '["nice_nano"]'
shield: '["corne_left","corne_right"]'
config: '["#define MIRYOKU_KLUDEGE_MOUSEKEYSPR"]'
kconfig: '["CONFIG_ZMK_MOUSE=y"]'
merge: '["=krikun98/zmk/mouse-pr"]'

23
readme.org
View File

@ -167,6 +167,7 @@ Additionally, building out of tree keyboards is automatically supported by the i
See the Test All Controllers, Boards, and Shields [[.github/workflows/][workflow files]] for lists of supported keyboards.
** Config File
The config file is used to specify [[https://github.com/manna-harbour/miryoku/tree/master/docs/reference#alternative-layouts][alternative layout]] and [[#mapping][mapping]] options for [[#Local-Builds][local builds]]. Options are given in the documentation in the form ~MIRYOKU_OPTION=VALUE~. Convert to the form ~#define MIRYOKU_OPTION_VALUE~ and add to the config file.
@ -175,6 +176,8 @@ The config file can also be used to set default alternative layout and mapping o
The config file can also be used to set other Miryoku ZMK configuration options for local and workflow builds.
Config file entries can also be specified in the [[#custom-config--config][config]] option for workflow builds.
The file is [[miryoku/custom_config.h]]. See the [[#example-config-file][example config file]]. The config file is included into the keyboard's keymap file before the mapping with:
#+BEGIN_SRC C :tangle no
@ -329,6 +332,9 @@ Examples include ~CONFIG_ZMK_SLEEP=y~, ~CONFIG_ZMK_DISPLAY=y~, ~CONFIG_BT_CTLR_T
*** Mouse Keys
**** Mouse Keys on Host
The Mouse and Button layers use [[https://en.wikipedia.org/wiki/Mouse_keys][mouse keys on the host]]. Middle button, right button, and scroll are not supported.
- [[https://linuxreviews.org/HOWTO_use_the_numeric_keyboard_keys_as_mouse_in_XOrg][X11]]
@ -336,6 +342,23 @@ The Mouse and Button layers use [[https://en.wikipedia.org/wiki/Mouse_keys][mous
- [[https://support.microsoft.com/en-us/windows/use-mouse-keys-to-move-the-mouse-pointer-9e0c72c8-b882-7918-8e7b-391fd62adf33][Windows]]
**** Mousekeys PR
Support for the [[https://github.com/zmkfirmware/zmk/pull/778][mousekeys PR]] is also included.
Add ~#define MIRYOKU_KLUDEGE_MOUSEKEYSPR~ to the [[#config-file][config file]].
Add ~CONFIG_ZMK_MOUSE=y~ to the [[#kconfig-configuration][Kconfig configuration]].
[[#zmk-branches--merge][Merge or build]] from the mousekeys PR branch ~krikun98/zmk/mouse-pr~
For [[#workflow-builds][workflow builds]], the [[#build-inputs][Build Inputs]] workflow can be used, or for [[#build-examples][Build Examlpe]] workflows see the [[./github/workflows/build-example-corne-nice_nano-mousekeyspr.yml][Build Example corne nice_nano mousekeyspr]] workflow.
For local builds, make the changes to the local files.
If the PR hasn't been rebased recently the automatic merge may fail. In that case merge manually or build directly from the branch.
*** Key Emulation Combos
Emulate a key with a combo of two other keys. Enabled automatically on keyboards with a missing key. Can be enabled on other keyboards for use with hard to reach keys, or for compatibility.