diff options
Diffstat (limited to 'docs/feature_userspace.md')
| -rw-r--r-- | docs/feature_userspace.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md index 454481cb2..c8fa406cb 100644 --- a/docs/feature_userspace.md +++ b/docs/feature_userspace.md @@ -25,19 +25,19 @@ 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 `<name>.h` file. +Additionally, `config.h` here will be processed like the same file in your keymap folder. This is handled separately from the `<name>.h` file. -The reason for this, is that `<name>.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `<name.h>` file in any `config.h` files will result in compile issues. +The reason for this, is that `<name>.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `<name.h>` file in any `config.h` files will result in compile issues. + +So you should use the `config.h` for QMK settings, and the `<name>.h` file for user or keymap specific settings. -So you should use the `config.h` for QMK settings, and the `<name>.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: +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 @@ -48,7 +48,7 @@ If you do add a `config,h` file, you want to make sure that it only gets process #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). +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 @@ -115,3 +115,11 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { This will add a new `KC_MAKE` keycode that can be used in any of your keymaps. And this keycode will output `make <keyboard>:<keymap">`, making frequent compiling easier. And this will work with any keyboard and any keymap as it will output the current boards info, so that you don't have to type this out every time. Additionally, this should flash the newly compiled firmware automatically, using the correct utility, based on the bootloader settings (or default to just generating the HEX file). However, it should be noted that this may not work on all systems. AVRDUDE doesn't work on WSL, namely (and will dump the HEX in the ".build" folder instead). + +## Override default userspace + +By default the userspace used will be the same as the keymap name. In some situations this isn't desirable. For instance, if you use the [layout](feature_layouts.md) feature you can't use the same name for different keymaps (e.g. ANSI and ISO). You can name your layouts `mylayout-ansi` and `mylayout-iso` and add the following line to your layout's `rules.mk`: + +``` +USER_NAME := mylayout +```
\ No newline at end of file |