]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - QMK-Overview.md
Updated QMK Overview (markdown)
[qmk_firmware.git] / QMK-Overview.md
index d9306cc7b367163dda66dc65a020e21e2bc80981..d90457daa1363fd6bd6d027a26aae856d20588f1 100644 (file)
@@ -30,12 +30,7 @@ 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`
+For more details on the QMK build process see [Make Instructions](Make-Instructions).
 
 ### Simple instructions for building and uploading a keyboard
 
@@ -53,9 +48,9 @@ In the above commands, replace:
 * `<programmer>` The programmer to use. Most keyboards use `dfu`, but some use `teensy`. Infinity keyboards use `dfu-util`. Check the readme file in the keyboard folder to find out which programmer to use.
   * If you  don't add `-<programmer` to the command line, the firmware will be still be compiled into a hex file, but the upload will be skipped.
 
-**NOTE:** Some operating systems will refuse to program unless you run the make command as root for example `sudo make dfu`
+**NOTE:** Some operating systems will refuse to program unless you run the make command as root for example `sudo make clueboard-default-dfu`
 
-#### Make Examples
+## Make Examples
 
 * Build all Clueboard keymaps: `make clueboard`
 * Build the default Planck keymap: `make planck-rev4-default`