aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-10-21 11:44:11 -1000
committerGitHub <noreply@github.com>2017-10-21 11:44:11 -1000
commit06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b (patch)
treea346452e61bf8047d18c9a6d4863cc4ac63a5717 /docs
parent9bb259b660925c7a5cd64b3a0a4484cdf757b504 (diff)
downloadqmk_firmware-06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b.tar.gz
qmk_firmware-06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b.zip
Creates a userspace for keymaps (#1559)
* create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/feature_userspace.md33
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index edbf04c1a..55cfd2ab3 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -15,6 +15,7 @@
15* [Features](features.md) 15* [Features](features.md)
16 * [Layouts](feature_layouts.md) 16 * [Layouts](feature_layouts.md)
17 * [Common Shortcuts](feature_common_shortcuts.md) 17 * [Common Shortcuts](feature_common_shortcuts.md)
18 * [Userspace](feature_userspace.md)
18 * [Backlight](feature_backlight.md) 19 * [Backlight](feature_backlight.md)
19 * [Bootmagic](feature_bootmagic.md) 20 * [Bootmagic](feature_bootmagic.md)
20 * [Dynamic Macros](dynamic_macros.md) 21 * [Dynamic Macros](dynamic_macros.md)
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
3If 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
15Additional files may be added in the same way - it's recommended you have one named `<name>`.c/.h though.
16
17All this only happens when you build a keymap named `<name>`, like this:
18
19 make planck:<name>
20
21For example,
22
23 make planck:jack
24
25Will include the `/users/jack/` folder in the path, along with `/users/jack/rules.mk`.
26
27## Readme
28
29Please 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
33For a brief example, checkout `/users/_example/` until we have more reasonable and useful examples. \ No newline at end of file