diff options
Diffstat (limited to 'docs/getting_started_make_guide.md')
| -rw-r--r-- | docs/getting_started_make_guide.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index 70390a510..1a7e27609 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
| @@ -55,7 +55,7 @@ Set these variables to `no` to disable them, and `yes` to enable them. | |||
| 55 | 55 | ||
| 56 | `BOOTMAGIC_ENABLE` | 56 | `BOOTMAGIC_ENABLE` |
| 57 | 57 | ||
| 58 | This allows you to hold a key and the salt key (space by default) and have access to a various EEPROM settings that persist over power loss. It's advised you keep this disabled, as the settings are often changed by accident, and produce confusing results that makes it difficult to debug. It's one of the more common problems encountered in help sessions. | 58 | This allows you to hold a key (usually Escape by default) to reset the EEPROM settings that persist over power loss and ready your keyboard to accept new firmware. |
| 59 | 59 | ||
| 60 | `MOUSEKEY_ENABLE` | 60 | `MOUSEKEY_ENABLE` |
| 61 | 61 | ||
| @@ -125,10 +125,6 @@ This allows you output audio on the C6 pin (needs abstracting). See the [audio p | |||
| 125 | 125 | ||
| 126 | Use this to debug changes to variable values, see the [tracing variables](unit_testing.md#tracing-variables) section of the Unit Testing page for more information. | 126 | Use this to debug changes to variable values, see the [tracing variables](unit_testing.md#tracing-variables) section of the Unit Testing page for more information. |
| 127 | 127 | ||
| 128 | `API_SYSEX_ENABLE` | ||
| 129 | |||
| 130 | This enables using the Quantum SYSEX API to send strings (somewhere?) | ||
| 131 | |||
| 132 | `KEY_LOCK_ENABLE` | 128 | `KEY_LOCK_ENABLE` |
| 133 | 129 | ||
| 134 | This enables [key lock](feature_key_lock.md). | 130 | This enables [key lock](feature_key_lock.md). |
| @@ -149,6 +145,10 @@ Lets you replace the default matrix scanning routine with your own code. For fur | |||
| 149 | 145 | ||
| 150 | Lets you replace the default key debouncing routine with an alternative one. If `custom` you will need to provide your own implementation. | 146 | Lets you replace the default key debouncing routine with an alternative one. If `custom` you will need to provide your own implementation. |
| 151 | 147 | ||
| 148 | `DEFERRED_EXEC_ENABLE` | ||
| 149 | |||
| 150 | Enables deferred executor support -- timed delays before callbacks are invoked. See [deferred execution](custom_quantum_functions.md#deferred-execution) for more information. | ||
| 151 | |||
| 152 | ## Customizing Makefile Options on a Per-Keymap Basis | 152 | ## Customizing Makefile Options on a Per-Keymap Basis |
| 153 | 153 | ||
| 154 | If 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. | 154 | If 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. |