summaryrefslogtreecommitdiff
path: root/docs/getting_started_introduction.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-04-09 09:26:11 -0700
committerDrashna Jaelre <drashna@live.com>2019-04-09 09:26:11 -0700
commit51a7fb1f1ea74648dc926354c887a04929297aba (patch)
tree653632f08da46b9dc8dc8ab65055927635087f85 /docs/getting_started_introduction.md
parent7c9d1d58ee9da18fa64cacd564fdf512ec4cb74e (diff)
Remove documentation folder
Diffstat (limited to 'docs/getting_started_introduction.md')
-rw-r--r--docs/getting_started_introduction.md54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
deleted file mode 100644
index 3b6a488ed6..0000000000
--- a/docs/getting_started_introduction.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Introduction
-
-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
-
-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:
-
-* `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`.
-
-### 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.
-
-* `config.h`: the options to configure your keymap
-* `keymap.c`: all of your keymap code, required
-* `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
-
-There are 3 possible `config.h` locations:
-
-* keyboard (`/keyboards/<keyboard>/config.h`)
-* 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 for the settings you wish to change.
-
-```
-#pragma once
-```
-
-Then to override a setting from the previous `config.h` file you must `#undef` and then `#define` the setting again.
-
-The boilerplate code and setting look like this together:
-
-```
-#pragma once
-
-// overrides go here!
-#undef MY_SETTING
-#define MY_SETTING 4
-```