From 06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Sat, 21 Oct 2017 11:44:11 -1000 Subject: Creates a userspace for keymaps (#1559) * create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap --- docs/feature_userspace.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/feature_userspace.md (limited to 'docs/feature_userspace.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 @@ +# Userspace: sharing code between keymaps + +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` + * `rules.mk` (included automatically) + * `.h` (optional) + * `.c` (optional) + +`.c` will need to be added to the SRC in `rules.mk` like this: + + SRC += .c + +Additional files may be added in the same way - it's recommended you have one named ``.c/.h though. + +All this only happens when you build a keymap named ``, like this: + + make planck: + +For example, + + make planck:jack + +Will include the `/users/jack/` folder in the path, along with `/users/jack/rules.mk`. + +## 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). + +## Example + +For a brief example, checkout `/users/_example/` until we have more reasonable and useful examples. \ No newline at end of file -- cgit v1.2.3-24-g4f1b