diff options
| author | William Chang <william@factual.com> | 2019-07-13 10:18:33 -0700 |
|---|---|---|
| committer | William Chang <william@factual.com> | 2019-07-13 10:18:33 -0700 |
| commit | 71493b2f9bbd5f3d18373c518fa14ccafcbf48fc (patch) | |
| tree | 3bb3e5e496621535611e087720aa5c4d7a533e5e /docs/getting_started_introduction.md | |
| parent | 86ad4988fe7ff64916127509d84f44c56fa097aa (diff) | |
| parent | da1f05fbc19477c05c0c01bb07fabfaf1ece9d54 (diff) | |
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'docs/getting_started_introduction.md')
| -rw-r--r-- | docs/getting_started_introduction.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md index 3b6a488ed6..e183d77eeb 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 |