From 5a0a9e1b8fadfc5e1aa626be71cd124bc62c8d69 Mon Sep 17 00:00:00 2001
From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com>
Date: Tue, 5 Apr 2022 17:13:44 +1000
Subject: [PATCH] Add MIRYOKU_KLUDGE_MOUSEKEYSPR docs and build example

---
 ...ld-example-corne-nice_nano-mousekeyspr.yml | 15 ++++++++++++
 readme.org                                    | 23 +++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 .github/workflows/build-example-corne-nice_nano-mousekeyspr.yml

diff --git a/.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml b/.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml
new file mode 100644
index 0000000..2d10182
--- /dev/null
+++ b/.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml
@@ -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"]'
diff --git a/readme.org b/readme.org
index 8e25b8a..e7c64e7 100644
--- a/readme.org
+++ b/readme.org
@@ -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.