From 162a67cbc567c11c507bfc153d155f5db2dd19bf Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Sat, 31 Mar 2018 21:02:40 -0700 Subject: Add userspace config.h handling to build script (#2640) * Add userspace 'config.h' file * Add more robust docs * Remove config.h code from drashna userspace * Spelling error * Include links to Config Options page * Remove config.h documentation from userspace doc, as it's no longer needed --- docs/feature_userspace.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md index 950377423..454481cb2 100644 --- a/docs/feature_userspace.md +++ b/docs/feature_userspace.md @@ -3,10 +3,11 @@ If you use more than one keyboard with a similar keymap, you might see the benefit in being able to share code between them. Create your own folder in `users/` named the same as your keymap (ideally your github username, ``) with the following structure: * `/users//` (added to the path automatically) - * `readme.md` + * `readme.md` (optional, recommended) * `rules.mk` (included automatically) * `.h` (optional) * `.c` (optional) + * `config.h` (optional) `.c` will need to be added to the SRC in `rules.mk` like this: @@ -24,10 +25,31 @@ For example, Will include the `/users/jack/` folder in the path, along with `/users/jack/rules.mk`. +Additionally, `config.h` here will be processed like the same file in your keymap folder. This is handled separately from the `.h` file. + +The reason for this, is that `.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `` file in any `config.h` files will result in compile issues. + +So you should use the `config.h` for QMK settings, and the `.h` file for user or keymap specific settings. + ## Readme Please include authorship (your name, github username, email), and optionally [a license that's GPL compatible](https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses). +## `Config.h` + +If you do add a `config,h` file, you want to make sure that it only gets processed once. So you may want to start off with something like this: + +```c +#ifndef USERSPACE_CONFIG_H +#define USERSPACE_CONFIG_H + +// Put normal config.h settings here: + +#endif // !USERSPACE_CONFIG_H +``` + +You can use any option hre that you could use in your keymap's `config.h` file. You can find a list of vales [here](config_options.md). + ## Example For a brief example, checkout `/users/_example/` , or for a more detailed examples check out [`template.h`](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/template.h) and [`template.c`](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/template.c) in `/users/drashna/` . -- cgit v1.2.3