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 849e99208..6cb644a22 100644 --- a/docs/getting_started_introduction.md +++ b/docs/getting_started_introduction.md | |||
| @@ -2,11 +2,11 @@ | |||
| 2 | 2 | ||
| 3 | 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. | 3 | 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. |
| 4 | 4 | ||
| 5 | ## Basic QMK structure | 5 | ## Basic QMK Structure |
| 6 | 6 | ||
| 7 | 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. | 7 | 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. |
| 8 | 8 | ||
| 9 | ### Keyboard project structure | 9 | ### Keyboard Project Structure |
| 10 | 10 | ||
| 11 | 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: | 11 | 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: |
| 12 | 12 | ||
| @@ -14,7 +14,7 @@ Within the folder `keyboards` and its subfolder `handwired` is a directory for e | |||
| 14 | * `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `Makefile` | 14 | * `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `Makefile` |
| 15 | * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. | 15 | * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. |
| 16 | 16 | ||
| 17 | ### Keymap structure | 17 | ### Keymap Structure |
| 18 | 18 | ||
| 19 | 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. | 19 | 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. |
| 20 | 20 | ||
| @@ -23,7 +23,7 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req | |||
| 23 | * `rules.mk`: the features of QMK that are enabled | 23 | * `rules.mk`: the features of QMK that are enabled |
| 24 | * `readme.md`: a description of your keymap, how others might use it, and explanations of features. Please upload images to a service like imgur. | 24 | * `readme.md`: a description of your keymap, how others might use it, and explanations of features. Please upload images to a service like imgur. |
| 25 | 25 | ||
| 26 | # The `config.h` file | 26 | # The `config.h` File |
| 27 | 27 | ||
| 28 | There are 2 `config.h` locations: | 28 | There are 2 `config.h` locations: |
| 29 | 29 | ||