varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity

Updated QMK Overview (markdown)

Browse source
This commit is contained in:
skullydazed 2017-02-16 17:04:10 -08:00
parent f9a7dd6cca
commit a3b575b740
1 changed files with 0 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
QMK-Overview.md
View file

@ -30,13 +30,6 @@ The `make` command is how you compile the firmware into a .hex file, which can b
**NOTE:** To abort a make command press `Ctrl-c`
The following instruction refers to these folders.
* The `root` (`/`) folder is the qmk_firmware folder, in which are `doc`, `keyboard`, `quantum`, etc.
* The `keyboard` folder is any keyboard project's folder, like `/keyboards/planck`.
* The `keymap` folder is any keymap's folder, like `/keyboards/planck/keymaps/default`.
* The `subproject` folder is the subproject folder of a keyboard, like `/keyboards/ergodox/ez`
### Simple instructions for building and uploading a keyboard
**Most keyboards have more specific instructions in the keyboard specific readme.md file, so please check that first**