]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Add Userspace mention
authorEvan Travers <evantravers@gmail.com>
Sat, 14 Jul 2018 21:47:41 +0000 (16:47 -0500)
committerJack Humbert <jack.humb@gmail.com>
Sun, 15 Jul 2018 17:21:20 +0000 (13:21 -0400)
@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.

docs/getting_started_introduction.md

index 504af7ba776a3b2a46ef85d3c9185f6cb4179d63..82a1ca19ae0c9b3b5e88d687590aac0b90db5bf7 100644 (file)
@@ -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: