Add user-overridable callback for cancelling UCIS input (#5564)

[qmk_firmware.git] / docs / getting_started_introduction.md

diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
index 504af7ba776a3b2a46ef85d3c9185f6cb4179d63..e183d77eeb57854157d9e7981efc325f18960894 100644 (file)
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@@ -6,13 +6,23 @@ This page attempts to explain the basic information you need to know to work wit
 
 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.
 
+### Userspace Structure
+
+Within the folder `users` is a directory for each user. This is a place for users to put code that they might use between keyboards. See the docs for [Userspace feature](feature_userspace.md) for more information.
+
 ### 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
 
@@ -31,15 +41,10 @@ There are 3 possible `config.h` locations:
 * userspace (`/users/<user>/config.h`)
 * keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
 
-The build system automatically picks up the config files in the above order. If you wish to override any setting set by a previous `config.h` you will need to first include some boilerplate code around the settings you wish to change.
+The build system automatically picks up the config files in the above order. If you wish to override any setting set by a previous `config.h` you will need to first include some boilerplate code for the settings you wish to change.
 
 ```
-#ifndef CONFIG_USER_H
-#define CONFIG_USER_H
-
-// overrides go here!
-
-#endif
+#pragma once
 ```
 
 Then to override a setting from the previous `config.h` file you must `#undef` and then `#define` the setting again.
@@ -47,12 +52,9 @@ Then to override a setting from the previous `config.h` file you must `#undef` a
 The boilerplate code and setting look like this together:
 
 ```
-#ifndef CONFIG_USER_H
-#define CONFIG_USER_H
+#pragma once
 
 // overrides go here!
 #undef MY_SETTING
 #define MY_SETTING 4
-
-#endif
 ```