diff options
Diffstat (limited to 'docs/getting_started_introduction.md')
-rw-r--r-- | docs/getting_started_introduction.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md index 504af7ba7..82a1ca19a 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 | |||
6 | 6 | ||
7 | 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. | 7 | 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. |
8 | 8 | ||
9 | ### Userspace Structure | ||
10 | |||
11 | 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. | ||
12 | |||
9 | ### Keyboard Project Structure | 13 | ### Keyboard Project Structure |
10 | 14 | ||
11 | 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: | 15 | 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: |