aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md11
-rw-r--r--docs/getting_started_make_guide.md14
2 files changed, 22 insertions, 3 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 63bcc41d0..f5c2e76e7 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -143,7 +143,7 @@ If you define these options you will enable the associated feature, which may in
143 * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle) 143 * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle)
144* `#define LEADER_TIMEOUT 300` 144* `#define LEADER_TIMEOUT 300`
145 * how long before the leader key times out 145 * how long before the leader key times out
146 * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped. 146 * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped.
147* `#define LEADER_PER_KEY_TIMING` 147* `#define LEADER_PER_KEY_TIMING`
148 * sets the timer for leader key chords to run on each key press rather than overall 148 * sets the timer for leader key chords to run on each key press rather than overall
149* `#define LEADER_KEY_STRICT_KEY_PROCESSING` 149* `#define LEADER_KEY_STRICT_KEY_PROCESSING`
@@ -197,6 +197,9 @@ If you define these options you will enable the associated feature, which may in
197 197
198Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk 198Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk
199 199
200* `SPLIT_TRANSPORT = custom`
201 * Allows replacing the standard split communication routines with a custom one. ARM based split keyboards must use this at present.
202
200### Setting Handedness 203### Setting Handedness
201 204
202One thing to remember, the side that the USB port is plugged into is always the master half. The side not plugged into USB is the slave. 205One thing to remember, the side that the USB port is plugged into is always the master half. The side not plugged into USB is the slave.
@@ -208,7 +211,7 @@ There are a few different ways to set handedness for split keyboards (listed in
2083. Set `MASTER_RIGHT`: Half that is plugged into the USB port is determined to be the master and right half (inverse of the default) 2113. Set `MASTER_RIGHT`: Half that is plugged into the USB port is determined to be the master and right half (inverse of the default)
2094. Default: The side that is plugged into the USB port is the master half and is assumed to be the left half. The slave side is the right half 2124. Default: The side that is plugged into the USB port is the master half and is assumed to be the left half. The slave side is the right half
210 213
211* `#define SPLIT_HAND_PIN B7` 214* `#define SPLIT_HAND_PIN B7`
212 * For using high/low pin to determine handedness, low = right hand, high = left hand. Replace `B7` with the pin you are using. This is optional, and if you leave `SPLIT_HAND_PIN` undefined, then you can still use the EE_HANDS method or MASTER_LEFT / MASTER_RIGHT defines like the stock Let's Split uses. 215 * For using high/low pin to determine handedness, low = right hand, high = left hand. Replace `B7` with the pin you are using. This is optional, and if you leave `SPLIT_HAND_PIN` undefined, then you can still use the EE_HANDS method or MASTER_LEFT / MASTER_RIGHT defines like the stock Let's Split uses.
213 216
214* `#define EE_HANDS` (only works if `SPLIT_HAND_PIN` is not defined) 217* `#define EE_HANDS` (only works if `SPLIT_HAND_PIN` is not defined)
@@ -302,6 +305,10 @@ Use these to enable or disable building certain features. The more you have enab
302 * Current options are AdafruitEzKey, AdafruitBLE, RN42 305 * Current options are AdafruitEzKey, AdafruitBLE, RN42
303* `SPLIT_KEYBOARD` 306* `SPLIT_KEYBOARD`
304 * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common 307 * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common
308* `CUSTOM_MATRIX`
309 * Allows replacing the standard matrix scanning routine with a custom one.
310* `CUSTOM_DEBOUNCE`
311 * Allows replacing the standard key debouncing routine with a custom one.
305* `WAIT_FOR_USB` 312* `WAIT_FOR_USB`
306 * Forces the keyboard to wait for a USB connection to be established before it starts up 313 * Forces the keyboard to wait for a USB connection to be established before it starts up
307* `NO_USB_STARTUP_CHECK` 314* `NO_USB_STARTUP_CHECK`
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index adc1aed75..bb7e1e7e3 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -97,7 +97,7 @@ This allows you to send Unicode characters using `UC(<code point>)` in your keym
97 97
98`UNICODEMAP_ENABLE` 98`UNICODEMAP_ENABLE`
99 99
100This allows you to send Unicode characters using `X(<map index>)` in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. 100This allows you to send Unicode characters using `X(<map index>)` in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported.
101 101
102`UCIS_ENABLE` 102`UCIS_ENABLE`
103 103
@@ -135,6 +135,18 @@ This enables [key lock](feature_key_lock.md). This consumes an additional 260 by
135 135
136This enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common 136This enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common
137 137
138`SPLIT_TRANSPORT`
139
140As there is no standard split communication driver for ARM-based split keyboards yet, `SPLIT_TRANSPORT = custom` must be used for these. It will prevent the standard split keyboard communication code (which is AVR-specific) from being included, allowing a custom implementation to be used.
141
142`CUSTOM_MATRIX`
143
144Lets you replace the default matrix scanning routine with your own code. You will need to provide your own implementations of matrix_init() and matrix_scan().
145
146`CUSTOM_DEBOUNCE`
147
148Lets you replace the default key debouncing routine with your own code. You will need to provide your own implementation of debounce().
149
138## Customizing Makefile Options on a Per-Keymap Basis 150## Customizing Makefile Options on a Per-Keymap Basis
139 151
140If your keymap directory has a file called `rules.mk` any options you set in that file will take precedence over other `rules.mk` options for your particular keyboard. 152If your keymap directory has a file called `rules.mk` any options you set in that file will take precedence over other `rules.mk` options for your particular keyboard.