forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated Home (markdown)

Browse Source
pull/1334/head
Christopher Browne 8 years ago
parent 1cefc94082
commit 942b78e8c2
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File

8
Home.md
Unescape View File

@ -229,12 +229,14 @@ For keyboards and subprojects, the make files are split in two parts `Makefile`
### Makefile options ### Makefile options
Set the variables to `no` to disable them, and `yes` to enable them. Set these variables to `no` to disable them, and `yes` to enable them.
`BOOTMAGIC_ENABLE` `BOOTMAGIC_ENABLE`
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. 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.
Consumes about 1000 bytes.
`MOUSEKEY_ENABLE` `MOUSEKEY_ENABLE`
This gives you control over cursor movements and clicks via keycodes/custom functions. This gives you control over cursor movements and clicks via keycodes/custom functions.
@ -259,6 +261,8 @@ To see the text, open `hid_listen` and enjoy looking at your printed messages.
**NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files. **NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files.
Consumes about 400 bytes.
`COMMAND_ENABLE` `COMMAND_ENABLE`
This enables magic commands, typically fired with the default magic key combo `LSHIFT+RSHIFT+KEY`. Magic commands include turning on debugging messages (`MAGIC+D`) or temporarily toggling NKRO (`MAGIC+N`). This enables magic commands, typically fired with the default magic key combo `LSHIFT+RSHIFT+KEY`. Magic commands include turning on debugging messages (`MAGIC+D`) or temporarily toggling NKRO (`MAGIC+N`).
@ -313,6 +317,8 @@ Use this to debug changes to variable values, see the [tracing variables](#traci
This enables using the Quantum SYSEX API to send strings (somewhere?) This enables using the Quantum SYSEX API to send strings (somewhere?)
This consumes about 5390 bytes.
### Customizing Makefile options on a per-keymap basis ### Customizing Makefile options on a per-keymap basis
If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard. If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard.

Write Preview
Loading…
Cancel
Save