ClaytonWWilson/miryoku_zmk
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-15 18:38:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Kconfig Configuration section in readme

Browse Source
This commit is contained in:
Manna Harbour 2023-01-23 11:27:50 +11:00
parent 000e094c68
commit 4564d39bcf
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
readme.org
View File

@ -422,12 +422,12 @@ The keyboard keymaps include the [[#config-file][config file]], a [[#mapping-mac
** Kconfig Configuration ** Kconfig Configuration
Kconfig keyboard configuration options can be set in ~config/<keyboard>.conf~ for [[#local-builds][local]] and [[#workflow-builds][workflow]] builds. [[https://zmk.dev/docs/config][Kconfig keyboard configuration options]] can be set in ~config/<keyboard>.conf~ as usual for [[#local-builds][local]] and [[#workflow-builds][workflow]] builds.
Examples include ~CONFIG_ZMK_SLEEP=y~, ~CONFIG_ZMK_DISPLAY=y~, ~CONFIG_BT_CTLR_TX_PWR_PLUS_8=y~.
Also see the default ~<keyboard>.conf~ included in the keyboard definition, e.g. [[https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/corne/corne.conf][corne.conf]].
Kconfig configuration can also be specified in the [[#kconfig][kconfig option]] for workflow builds. Kconfig configuration can also be specified in the [[#kconfig][kconfig option]] for workflow builds.
Examples include ~CONFIG_ZMK_SLEEP=y~, ~CONFIG_ZMK_DISPLAY=y~, ~CONFIG_BT_CTLR_TX_PWR_PLUS_8=y~. Additional documentation is available at [[https://deploy-preview-722--zmk.netlify.app/docs/config/index/]]. Also see the default ~<keyboard>.conf~ included in the keyboard definition, e.g. [[https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/corne/corne.conf][corne.conf]].
** Additional and Experimental Features ** Additional and Experimental Features
@ -459,6 +459,7 @@ Shift functions for RGB and EP can be enabled for use with non-split keyboards.
Use with split keyboards will result in the shifted as well as the unshifted functions for RGB and EP only taking effect on the central side. Use with split keyboards will result in the shifted as well as the unshifted functions for RGB and EP only taking effect on the central side.
*** Key Emulation Combos *** 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. 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.