From 3abaa2cf302541bb598175d2db55f6906ae71e25 Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Thu, 2 Jun 2022 14:06:29 +1000 Subject: [PATCH] Reorder additional features subheadings in readme --- readme.org | 56 +++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/readme.org b/readme.org index aed7388..dc54fe7 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 [[#mouse-keys][mouse keys]] and [[#key-emulation-combos][key emulation combos]]. +[[#additional-and-experimental-features][Additional and Experimental Features]] include [[#caps-word][caps word]], [[#key-emulation-combos][key emulation combos]] and [[#mouse-keys][mouse keys]]. ** Building @@ -370,7 +370,33 @@ Examples include ~CONFIG_ZMK_SLEEP=y~, ~CONFIG_ZMK_DISPLAY=y~, ~CONFIG_BT_CTLR_T *** Caps Word -[[https://zmk.dev/docs/behaviors/caps-word][Caps Word]] is used in place of ~Caps Lock~. Combine with ~Shift~ for ~Caps Lock~. +[[https://zmk.dev/docs/behaviors/caps-word][Caps word]] is used in place of ~Caps Lock~. Combine with ~Shift~ for ~Caps Lock~. + + +*** 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. + +See https://github.com/manna-harbour/miryoku/issues/56. + + +**** Top Row Combos + +On the top row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key. + +Requires ~CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16~ [[#kconfig-configuration][Kconfig configuration]]. + + +**** Bottom Row Combos + +On the bottom row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key. + +Requires ~CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16~ [[#kconfig-configuration][Kconfig configuration]]. + + +**** Thumb Combos + +On each hand, combo the primary and secondary thumb keys to emulate the tertiary thumb key. Requires suitable keycaps to enable the thumb to press both keys simultaneously. *** Mouse Keys @@ -400,32 +426,6 @@ For [[#workflow-builds][workflow builds]], the [[#build-inputs][Build Inputs]] w For local builds, make the changes locally. -*** 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. - -See https://github.com/manna-harbour/miryoku/issues/56. - - -**** Top Row Combos - -On the top row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key. - -Requires ~CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16~ [[#kconfig-configuration][Kconfig configuration]]. - - -**** Bottom Row Combos - -On the bottom row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key. - -Requires ~CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16~ [[#kconfig-configuration][Kconfig configuration]]. - - -**** Thumb Combos - -On each hand, combo the primary and secondary thumb keys to emulate the tertiary thumb key. Requires suitable keycaps to enable the thumb to press both keys simultaneously. - - ** [[https://github.com/manna-harbour][https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png]]