summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2017-02-16 17:07:39 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2017-02-16 17:07:39 -0800
commit56e9a286b5679d6f94236fce6502b925ef163551 (patch)
tree5f657b9256b02142d4c4fd5f73d62a071bd98b0e
parentcdef9bd02f909d97f3f3232267fa14ed9ab4e300 (diff)
Updated QMK Overview (markdown)
-rw-r--r--QMK-Overview.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/QMK-Overview.md b/QMK-Overview.md
index d90457daa1..8803d7c554 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