]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Updated QMK Overview (markdown)
authorskullydazed <skullydazed@users.noreply.github.com>
Fri, 17 Feb 2017 01:07:39 +0000 (17:07 -0800)
committerskullydazed <skullydazed@users.noreply.github.com>
Fri, 17 Feb 2017 01:07:39 +0000 (17:07 -0800)
QMK-Overview.md

index d90457daa1363fd6bd6d027a26aae856d20588f1..8803d7c554789914a986459bb920a9669255e05d 100644 (file)
@@ -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