diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2017-02-17 02:07:39 +0100 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2017-02-17 02:07:39 +0100 |
| commit | 56e9a286b5679d6f94236fce6502b925ef163551 (patch) | |
| tree | 5f657b9256b02142d4c4fd5f73d62a071bd98b0e /QMK-Overview.md | |
| parent | cdef9bd02f909d97f3f3232267fa14ed9ab4e300 (diff) | |
| download | qmk_firmware-56e9a286b5679d6f94236fce6502b925ef163551.tar.gz qmk_firmware-56e9a286b5679d6f94236fce6502b925ef163551.tar.xz | |
Updated QMK Overview (markdown)
Diffstat (limited to 'QMK-Overview.md')
| -rw-r--r-- | QMK-Overview.md | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/QMK-Overview.md b/QMK-Overview.md index d90457daa..8803d7c55 100644 --- a/QMK-Overview.md +++ b/QMK-Overview.md @@ -54,4 +54,22 @@ In the above commands, replace: * Build all Clueboard keymaps: `make clueboard` * Build the default Planck keymap: `make planck-rev4-default` -* Build and flash your ergodox-ez: `make ergodox-ez-default-teensy`
\ No newline at end of file +* Build and flash your ergodox-ez: `make ergodox-ez-default-teensy` + +# The `config.h` file + +There are 2 `config.h` locations: + +* keyboard (`/keyboards/<keyboard>/`) +* keymap (`/keyboards/<keyboard>/keymaps/<keymap>/`) + +The keyboard `config.h` is included only if the keymap one doesn't exist. The format to use for your custom one [is here](/doc/keymap_config_h_example.h). If you want to override a setting from the parent `config.h` file, you need to do this: + +```c +#undef MY_SETTING +#define MY_SETTING 4 +``` + +For a value of `4` for this imaginary setting. So we `undef` it first, then `define` it. + +You can then override any settings, rather than having to copy and paste the whole thing.
\ No newline at end of file |