diff options
Diffstat (limited to 'docs/getting_started_introduction.md')
| -rw-r--r-- | docs/getting_started_introduction.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md index 849e992085..6cb644a22d 100644 --- a/docs/getting_started_introduction.md +++ b/docs/getting_started_introduction.md @@ -2,11 +2,11 @@ This page attempts to explain the basic information you need to know to work with the QMK project. It assumes that you are familiar with navigating a Unix shell, but does not assume you are familiar with C or with compiling using make. -## Basic QMK structure +## Basic QMK Structure 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. -### Keyboard project structure +### 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: @@ -14,7 +14,7 @@ Within the folder `keyboards` and its subfolder `handwired` is a directory for e * `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `Makefile` * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. -### Keymap structure +### Keymap Structure In every keymap folder, the following files may be found. Only `keymap.c` is required, and if the rest of the files are not found the default options will be chosen. @@ -23,7 +23,7 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req * `rules.mk`: the features of QMK that are enabled * `readme.md`: a description of your keymap, how others might use it, and explanations of features. Please upload images to a service like imgur. -# The `config.h` file +# The `config.h` File There are 2 `config.h` locations: |