From f1187dd3c628732c55036ab1e8dac7342b3397c5 Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Thu, 2 Jun 2022 14:07:49 +1000 Subject: [PATCH] Add customisation section to readme --- readme.org | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/readme.org b/readme.org index dc54fe7..56ab670 100644 --- a/readme.org +++ b/readme.org @@ -19,7 +19,7 @@ Workflow builds can be customised by copying and editing one of the [[#build-exa The [[#keyboard-keymaps][keyboard keymaps]] are composed of the config file, a [[#mapping-macros][mapping]] for the physical layout, and the [[#miryoku-keymap][Miryoku keymap]]. -[[#additional-and-experimental-features][Additional and Experimental Features]] include [[#caps-word][caps word]], [[#key-emulation-combos][key emulation combos]] and [[#mouse-keys][mouse keys]]. +[[#additional-and-experimental-features][Additional and Experimental Features]] include [[#caps-word][caps word]], [[#customisation][customisation]], [[#key-emulation-combos][key emulation combos]] and [[#mouse-keys][mouse keys]]. ** Building @@ -373,6 +373,11 @@ Examples include ~CONFIG_ZMK_SLEEP=y~, ~CONFIG_ZMK_DISPLAY=y~, ~CONFIG_BT_CTLR_T [[https://zmk.dev/docs/behaviors/caps-word][Caps word]] is used in place of ~Caps Lock~. Combine with ~Shift~ for ~Caps Lock~. +*** Customisation + +See https://github.com/manna-harbour/miryoku/discussions/85. + + *** 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.