aboutsummaryrefslogtreecommitdiff
path: root/docs/config_options.md
diff options
context:
space:
mode:
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
31 31
32 #include "config_common.h" 32 #include "config_common.h"
33 33
34## `config.h` Options
35 34
36### Hardware Options 35## Hardware Options
37* `#define VENDOR_ID 0x1234` 36* `#define VENDOR_ID 0x1234`
38 * defines your VID, and for most DIY projects, can be whatever you want 37 * defines your VID, and for most DIY projects, can be whatever you want
39* `#define PRODUCT_ID 0x5678` 38* `#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
83* `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )` 82* `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
84 * key combination that allows the use of magic commands (useful for debugging) 83 * key combination that allows the use of magic commands (useful for debugging)
85 84
86### Features That Can Be Disabled 85## Features That Can Be Disabled
87 86
88If you define these options you will disable the associated feature, which can save on code size. 87If you define these options you will disable the associated feature, which can save on code size.
89 88
@@ -102,7 +101,7 @@ If you define these options you will disable the associated feature, which can s
102* `#define NO_ACTION_FUNCTION` 101* `#define NO_ACTION_FUNCTION`
103 * disable the action function (deprecated) 102 * disable the action function (deprecated)
104 103
105### Features That Can Be Enabled 104## Features That Can Be Enabled
106 105
107If you define these options you will enable the associated feature, which may increase your code size. 106If you define these options you will enable the associated feature, which may increase your code size.
108 107
@@ -111,7 +110,7 @@ If you define these options you will enable the associated feature, which may in
111* `#define PREVENT_STUCK_MODIFIERS` 110* `#define PREVENT_STUCK_MODIFIERS`
112 * when switching layers, this will release all mods 111 * when switching layers, this will release all mods
113 112
114### Behaviors That Can Be Configured 113## Behaviors That Can Be Configured
115 114
116* `#define TAPPING_TERM 200` 115* `#define TAPPING_TERM 200`
117 * how long before a tap becomes a hold 116 * 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
139 few ms of delay from this. But if you're doing chording on something with 3-4ms 138 few ms of delay from this. But if you're doing chording on something with 3-4ms
140 scan times? You probably want this. 139 scan times? You probably want this.
141 140
142### RGB Light Configuration 141## RGB Light Configuration
143 142
144* `#define RGB_DI_PIN D7` 143* `#define RGB_DI_PIN D7`
145 * pin the DI on the ws2812 is hooked-up to 144 * 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
156* `#define RGBW_BB_TWI` 155* `#define RGBW_BB_TWI`
157 * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ) 156 * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
158 157
159### Mouse Key Options 158## Mouse Key Options
160 159
161* `#define MOUSEKEY_INTERVAL 20` 160* `#define MOUSEKEY_INTERVAL 20`
162* `#define MOUSEKEY_DELAY 0` 161* `#define MOUSEKEY_DELAY 0`
@@ -168,9 +167,7 @@ If you define these options you will enable the associated feature, which may in
168 167
169This 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. 168This 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.
170 169
171## `rules.mk` Options 170## Build Options
172
173### Build Options
174 171
175* `DEFAULT_FOLDER` 172* `DEFAULT_FOLDER`
176 * Used to specify a default folder when a keyboard has more than one sub-folder. 173 * 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
179* `LAYOUTS` 176* `LAYOUTS`
180 * A list of [layouts](feature_layouts.md) this keyboard supports. 177 * A list of [layouts](feature_layouts.md) this keyboard supports.
181 178
182### AVR MCU Options 179## AVR MCU Options
183* `MCU = atmega32u4` 180* `MCU = atmega32u4`
184* `F_CPU = 16000000` 181* `F_CPU = 16000000`
185* `ARCH = AVR8` 182* `ARCH = AVR8`
@@ -193,7 +190,7 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
193 * `caterina` 190 * `caterina`
194 * `bootloadHID` 191 * `bootloadHID`
195 192
196### Feature Options 193## Feature Options
197 194
198Use 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. 195Use 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.
199 196