From 56e9a286b5679d6f94236fce6502b925ef163551 Mon Sep 17 00:00:00 2001 From: skullydazed Date: Thu, 16 Feb 2017 17:07:39 -0800 Subject: [PATCH] Updated QMK Overview (markdown) --- QMK-Overview.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) 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//`) +* keymap (`/keyboards//keymaps//`) + +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