aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar Elliot Powell <32494740+e11i0t23@users.noreply.github.com>2019-05-31 22:44:27 +0100
committerGravatar Drashna Jaelre <drashna@live.com>2019-05-31 14:44:27 -0700
commitd3317a8a66e1a94de0dd795f5c9efe260e674475 (patch)
treeb706ca7e39fe4e18123aa1142ba446ccecf3c890 /docs
parentf9c0936cea630e078618bfd8ef3b686dacce2e76 (diff)
downloadqmk_firmware-d3317a8a66e1a94de0dd795f5c9efe260e674475.tar.gz
[Docs] Update getting_started_introduction.md (#6037)
* Update getting_started_introduction.md * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started_introduction.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
index 3b6a488ed..e183d77ee 100644
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@@ -12,11 +12,17 @@ Within the folder `users` is a directory for each user. This is a place for user
### 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:
+Within the folder `keyboards`, its subfolder `handwired` and its vendor and manufacture subdirectories e.g. `clueboard` is a directory for each keyboard project, for example `qmk_firmware/keyboards/clueboard/2x1800`. Within it, you'll find the following structure:
* `keymaps/`: Different keymaps that can be built
* `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `rules.mk`.
* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
+* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support.md) for more information.
+* `readme.md`: A brief overview of the keyboard.
+* `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
+* `<keyboardName>.c`: This file is where you can find custom code for the keyboard.
+
+For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines.md).
### Keymap Structure