diff options
Diffstat (limited to 'docs/feature_userspace.md')
-rw-r--r-- | docs/feature_userspace.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md index ac0a1360d..8665481db 100644 --- a/docs/feature_userspace.md +++ b/docs/feature_userspace.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # Userspace: Sharing Code Between Keymaps | 1 | # Userspace: Sharing Code Between Keymaps |
2 | 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: | 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 | 4 | ||
5 | * `/users/<name>/` (added to the path automatically) | 5 | * `/users/<name>/` (added to the path automatically) |
6 | * `readme.md` (optional, recommended) | 6 | * `readme.md` (optional, recommended) |
@@ -73,7 +73,7 @@ The reason for this, is that `<name>.h` won't be added in time to add settings ( | |||
73 | 73 | ||
74 | ## Readme (`readme.md`) | 74 | ## Readme (`readme.md`) |
75 | 75 | ||
76 | 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). | 76 | 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). |
77 | 77 | ||
78 | You can use this as a template: | 78 | You can use this as a template: |
79 | ``` | 79 | ``` |
@@ -93,7 +93,7 @@ You should have received a copy of the GNU General Public License | |||
93 | along with this program. If not, see <http://www.gnu.org/licenses/>. | 93 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
94 | ``` | 94 | ``` |
95 | 95 | ||
96 | You'd want to replace the year, name, email and github username with your info. | 96 | You'd want to replace the year, name, email and GitHub username with your info. |
97 | 97 | ||
98 | Additionally, this is a good place to document your code, if you wish to share it with others. | 98 | Additionally, this is a good place to document your code, if you wish to share it with others. |
99 | 99 | ||