Skip to content

Commit

Permalink
[Docs] Update getting_started_introduction.md (qmk#6037)
Browse files Browse the repository at this point in the history
* Update getting_started_introduction.md

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <[email protected]>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <[email protected]>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <[email protected]>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <[email protected]>
  • Loading branch information
2 people authored and swamp09 committed Mar 11, 2020
1 parent 5115fab commit 681530c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/getting_started_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 681530c

Please sign in to comment.