diff options
| author | Drashna Jaelre <drashna@live.com> | 2022-03-17 14:19:34 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-17 21:19:34 +0000 |
| commit | 02655690f48ec64ba982499cd3272ee6076b73b3 (patch) | |
| tree | d7c0530d0142f93c99b895120460a5ac2303c453 /docs | |
| parent | 2749346a539c2385218a32937ae7992cf80fb263 (diff) | |
[Core] Add compile/make macro to core (#15959)
* [Core] Add KC_MAKE keycode to core
fix linting
fix testing error
work around test idiocyncracies
fix more lint
something something stupid tests
add doc
* updates based on feedback
* Add bad names
* Fixup docs
* semantics but cleaner
Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
* Hide oneshot checks behind preprocessors
* Move no-compile option around
* Fix formatting
* make shift optional
* Make opt in
* fix formatting
* update send string function name
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config_options.md | 2 | ||||
| -rw-r--r-- | docs/keycodes.md | 11 | ||||
| -rw-r--r-- | docs/quantum_keycodes.md | 11 |
3 files changed, 14 insertions, 10 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 838c4d86fd..8227a0e074 100644 --- a/docs/config_options.md +++ b/docs/config_options.md @@ -131,6 +131,8 @@ If you define these options you will disable the associated feature, which can s If you define these options you will enable the associated feature, which may increase your code size. +* `#define ENABLE_COMPILE_KEYCODE` + * Enables the `QK_MAKE` keycode * `#define FORCE_NKRO` * NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots. * `#define STRICT_LAYER_RELEASE` diff --git a/docs/keycodes.md b/docs/keycodes.md index 58ce43d309..942e0a6616 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -219,11 +219,12 @@ See also: [Basic Keycodes](keycodes_basic.md) See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) -|Key |Aliases |Description | -|-----------------|---------|-------------------------------------------------------| -|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | -|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | -|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)| +|Key |Aliases |Description | +|-----------------|---------|---------------------------------------------------------------------------------| +|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | +|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | +|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory) | +|`QK_MAKE` | |Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held | ## Audio Keys :id=audio-keys diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md index 8e29e05886..46a8b7de19 100644 --- a/docs/quantum_keycodes.md +++ b/docs/quantum_keycodes.md @@ -8,8 +8,9 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are ## QMK Keycodes :id=qmk-keycodes -|Key |Aliases |Description | -|-----------------|---------|-------------------------------------------------------| -|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | -|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | -|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)| +|Key |Aliases |Description | +|-----------------|---------|---------------------------------------------------------------------------------| +|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | +|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | +|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory) | +|`QK_MAKE` | |Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held | |