aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_make_guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting_started_make_guide.md')
-rw-r--r--docs/getting_started_make_guide.md14
1 files changed, 13 insertions, 1 deletions
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.