Skip to content

Commit

Permalink
Update Kconfig Configuration section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
manna-harbour committed Jan 23, 2023
1 parent 000e094 commit 4564d39
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -422,12 +422,12 @@ The keyboard keymaps include the [[#config-file][config file]], a [[#mapping-mac

** 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.

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

Expand Down Expand Up @@ -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.


*** 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.
Expand Down

0 comments on commit 4564d39

Please sign in to comment.