summaryrefslogtreecommitdiffstats
path: root/users/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-10-21 23:44:11 +0200
committerGitHub <noreply@github.com>2017-10-21 23:44:11 +0200
commit06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b (patch)
treea346452e61bf8047d18c9a6d4863cc4ac63a5717 /users/readme.md
parent9bb259b660925c7a5cd64b3a0a4484cdf757b504 (diff)
downloadqmk_firmware-06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b.tar.gz
qmk_firmware-06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b.tar.xz
Creates a userspace for keymaps (#1559)
* create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap
Diffstat (limited to 'users/readme.md')
-rw-r--r--users/readme.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/users/readme.md b/users/readme.md
new file mode 100644
index 000000000..d8f14d8be
--- /dev/null
+++ b/users/readme.md
@@ -0,0 +1,3 @@
+# User space
+
+This is a place for users to put code that they might use between keyboards. If you build the keymap `mine`, `/users/mine/rules.mk` will be included in your build, and `/users/mine/` will be in your path - keep these things in mind when naming your files and referencing them from other places. \ No newline at end of file