From 6f0b8bea9f94f36aad24e996f72814750fa7ee90 Mon Sep 17 00:00:00 2001 From: urob <978080+urob@users.noreply.github.com> Date: Sat, 14 Dec 2024 23:45:52 -0500 Subject: [PATCH] Document Kconfig options --- Kconfig | 2 +- README.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Kconfig b/Kconfig index ab4ee9a..a0de3c7 100644 --- a/Kconfig +++ b/Kconfig @@ -5,7 +5,7 @@ config ZMK_LEADER_MAX_KEYS_PER_SEQUENCE default 5 config ZMK_LEADER_MAX_SEQUENCES - int "Maximum number of leader sequences" + int "Maximum number of leader sequences per instance" default 32 #Leader options diff --git a/README.md b/README.md index 8924f66..d1f5edd 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,13 @@ ignored when evaluating sequences. For instance, if `ignore-keys = `, "shift" is passed through without triggering or terminating sequences. +### `Kconfig` options + +- `CONFIG_ZMK_LEADER_MAX_KEYS_PER_SEQUENCE`: Maximum number of keys in a + sequence. Default is 5. +- `CONFIG_ZMK_LEADER_MAX_SEQUENCES`: Maximum number of sequences per leader key + instance. Default is 32. + ## References - The [legacy](https://github.com/urob/zmk-leader-key/tree/legacy) branch ports