summaryrefslogtreecommitdiffstats
path: root/docs/config_options.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-03-26 01:44:17 +0200
committerskullydazed <skullydazed@users.noreply.github.com>2018-03-26 01:44:17 +0200
commit07b90db89758c42f7aacf52d93446b9407b87a98 (patch)
tree29392050d8c473eb0c6874977477ba32a9176f3b /docs/config_options.md
parent0c665696d7b498bd278d05eed3b52c1fac89ff29 (diff)
downloadqmk_firmware-07b90db89758c42f7aacf52d93446b9407b87a98.tar.gz
qmk_firmware-07b90db89758c42f7aacf52d93446b9407b87a98.tar.xz
Fixes and updates to docs (#2611)
* Fix advanced keycode headers * Add caveat for OSM over Remote Desktop * Hopefully add better anchors to docs * Add Action code list reference * Formatting of RGB Underglow doc * Add brew update issue on macOS * Revert formatting * Revert RGB doc formatting * Make Config Options doc's sections linkable
Diffstat (limited to 'docs/config_options.md')
-rw-r--r--docs/config_options.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 055531b67..af8602c3f 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -31,9 +31,8 @@ This is a C header file that is one of the first things included, and will persi
#include "config_common.h"
-## `config.h` Options
-### Hardware Options
+## Hardware Options
* `#define VENDOR_ID 0x1234`
* defines your VID, and for most DIY projects, can be whatever you want
* `#define PRODUCT_ID 0x5678`
@@ -83,7 +82,7 @@ This is a C header file that is one of the first things included, and will persi
* `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
* key combination that allows the use of magic commands (useful for debugging)
-### Features That Can Be Disabled
+## Features That Can Be Disabled
If you define these options you will disable the associated feature, which can save on code size.
@@ -102,7 +101,7 @@ If you define these options you will disable the associated feature, which can s
* `#define NO_ACTION_FUNCTION`
* disable the action function (deprecated)
-### Features That Can Be Enabled
+## Features That Can Be Enabled
If you define these options you will enable the associated feature, which may increase your code size.
@@ -111,7 +110,7 @@ If you define these options you will enable the associated feature, which may in
* `#define PREVENT_STUCK_MODIFIERS`
* when switching layers, this will release all mods
-### Behaviors That Can Be Configured
+## Behaviors That Can Be Configured
* `#define TAPPING_TERM 200`
* how long before a tap becomes a hold
@@ -139,7 +138,7 @@ If you define these options you will enable the associated feature, which may in
few ms of delay from this. But if you're doing chording on something with 3-4ms
scan times? You probably want this.
-### RGB Light Configuration
+## RGB Light Configuration
* `#define RGB_DI_PIN D7`
* pin the DI on the ws2812 is hooked-up to
@@ -156,7 +155,7 @@ If you define these options you will enable the associated feature, which may in
* `#define RGBW_BB_TWI`
* bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
-### Mouse Key Options
+## Mouse Key Options
* `#define MOUSEKEY_INTERVAL 20`
* `#define MOUSEKEY_DELAY 0`
@@ -168,9 +167,7 @@ If you define these options you will enable the associated feature, which may in
This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.
-## `rules.mk` Options
-
-### Build Options
+## Build Options
* `DEFAULT_FOLDER`
* Used to specify a default folder when a keyboard has more than one sub-folder.
@@ -179,7 +176,7 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
* `LAYOUTS`
* A list of [layouts](feature_layouts.md) this keyboard supports.
-### AVR MCU Options
+## AVR MCU Options
* `MCU = atmega32u4`
* `F_CPU = 16000000`
* `ARCH = AVR8`
@@ -193,7 +190,7 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
* `caterina`
* `bootloadHID`
-### Feature Options
+## Feature Options
Use these to enable or disable building certain features. The more you have enabled the bigger your firmware will be, and you run the risk of building a firmware too large for your MCU.