diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/getting_started_introduction.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/getting_started_introduction.md')
| -rw-r--r-- | docs/getting_started_introduction.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md index 8020335345..9417351747 100644 --- a/docs/getting_started_introduction.md +++ b/docs/getting_started_introduction.md | |||
| @@ -8,7 +8,7 @@ QMK is a fork of [Jun Wako](https://github.com/tmk)'s [tmk_keyboard](https://git | |||
| 8 | 8 | ||
| 9 | ### Userspace Structure | 9 | ### Userspace Structure |
| 10 | 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. | 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) for more information. |
| 12 | 12 | ||
| 13 | ### Keyboard Project Structure | 13 | ### Keyboard Project Structure |
| 14 | 14 | ||
| @@ -17,12 +17,12 @@ Within the folder `keyboards`, its subfolder `handwired` and its vendor and manu | |||
| 17 | * `keymaps/`: Different keymaps that can be built | 17 | * `keymaps/`: Different keymaps that can be built |
| 18 | * `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `rules.mk`. | 18 | * `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `rules.mk`. |
| 19 | * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. | 19 | * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. |
| 20 | * `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support.md) for more information. | 20 | * `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information. |
| 21 | * `readme.md`: A brief overview of the keyboard. | 21 | * `readme.md`: A brief overview of the keyboard. |
| 22 | * `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix. | 22 | * `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix. |
| 23 | * `<keyboardName>.c`: This file is where you can find custom code for the keyboard. | 23 | * `<keyboardName>.c`: This file is where you can find custom code for the keyboard. |
| 24 | 24 | ||
| 25 | For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines.md). | 25 | For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines). |
| 26 | 26 | ||
| 27 | ### Keymap Structure | 27 | ### Keymap Structure |
| 28 | 28 | ||
