diff options
Diffstat (limited to 'docs/feature_userspace.md')
-rw-r--r-- | docs/feature_userspace.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md new file mode 100644 index 000000000..edc9f6e32 --- /dev/null +++ b/docs/feature_userspace.md | |||
@@ -0,0 +1,33 @@ | |||
1 | # Userspace: sharing code between keymaps | ||
2 | |||
3 | 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, `<name>`) with the following structure: | ||
4 | |||
5 | * `/users/<name>/` (added to the path automatically) | ||
6 | * `readme.md` | ||
7 | * `rules.mk` (included automatically) | ||
8 | * `<name>.h` (optional) | ||
9 | * `<name>.c` (optional) | ||
10 | |||
11 | `<name>.c` will need to be added to the SRC in `rules.mk` like this: | ||
12 | |||
13 | SRC += <name>.c | ||
14 | |||
15 | Additional files may be added in the same way - it's recommended you have one named `<name>`.c/.h though. | ||
16 | |||
17 | All this only happens when you build a keymap named `<name>`, like this: | ||
18 | |||
19 | make planck:<name> | ||
20 | |||
21 | For example, | ||
22 | |||
23 | make planck:jack | ||
24 | |||
25 | Will include the `/users/jack/` folder in the path, along with `/users/jack/rules.mk`. | ||
26 | |||
27 | ## Readme | ||
28 | |||
29 | 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). | ||
30 | |||
31 | ## Example | ||
32 | |||
33 | For a brief example, checkout `/users/_example/` until we have more reasonable and useful examples. \ No newline at end of file | ||