summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Travers <evantravers@gmail.com>2018-07-14 16:47:41 -0500
committerJack Humbert <jack.humb@gmail.com>2018-07-15 13:21:20 -0400
commit3d7bfae2323f64778b1e9c6b402c84befaa30301 (patch)
tree3f8cc0e26c9c4a8a3ced0e941880570783a30647
parentb666921e258838f8eb8dcd9038f6f4f7f4159453 (diff)
Add Userspace mention
@drashna mentioned it'd be good to have a mention of the userspace in the QMK structure section. Rather than rewrite the docs on userspace, I chose to link to the existing documentation.
-rw-r--r--docs/getting_started_introduction.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
index 504af7ba77..82a1ca19ae 100644
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@@ -6,6 +6,10 @@ This page attempts to explain the basic information you need to know to work wit
QMK is a fork of [Jun Wako](https://github.com/tmk)'s [tmk_keyboard](https://github.com/tmk/tmk_keyboard) project. The original TMK code, with modifications, can be found in the `tmk` folder. The QMK additions to the project may be found in the `quantum` folder. Keyboard projects may be found in the `handwired` and `keyboard` folders.
+### Userspace Structure
+
+Within the folder `users` is a directory for each user. This is a place for users to put code that they might use between keyboards. See the docs for [Userspace feature](feature_userspace.md) for more information.
+
### Keyboard Project Structure
Within the folder `keyboards` and its subfolder `handwired` is a directory for each keyboard project, for example `qmk_firmware/keyboards/clueboard`. Within it you'll find the following structure: