]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - docs/flashing.md
Keymap: Add fauxclicky support to my keymap (#3625)
[qmk_firmware.git] / docs / flashing.md
index 5b3c1a444790deb97e9626e2ce94cc40b7b743d7..e5fe59f8f03948a67e3e010cb75c8309da3c4f79 100644 (file)
@@ -1,4 +1,4 @@
-# Flashing Intrustructions / Bootloader Information
+# Flashing Instructions and Bootloader Information
 
 There are quite a few different types of bootloaders that keyboards use, and just about all of the use a different flashing method. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them.
 
@@ -8,19 +8,19 @@ If you have a bootloader selected with the `BOOTLOADER` variable in your `rules.
 
 Atmel's DFU bootloader comes on all atmega32u4 chips by default, and is used by many keyboards that have their own ICs on their PCBs (Older OLKB boards, Clueboards). Some keyboards may also use LUFA's DFU bootloader (or QMK's fork) (Newer OLKB boards) that adds in additional features specific to that hardware.
 
-To ensure compatability with the DFU bootloader, make sure this block is present your `rules.mk` (optionally with `lufa-dfu` or `qmk-dfu` instead):
+To ensure compatibility with the DFU bootloader, make sure this block is present your `rules.mk` (optionally with `lufa-dfu` or `qmk-dfu` instead):
 
     # Bootloader
     #     This definition is optional, and if your keyboard supports multiple bootloaders of
-    #     different sizes, comment this out, and the correct address will be loaded 
+    #     different sizes, comment this out, and the correct address will be loaded
     #     automatically (+60). See bootloader.mk for all options.
     BOOTLOADER = atmel-dfu
 
 Compatible flashers:
 
 * [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
-* [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer) / `:dfu` in QMK (recommended commandline)
-* [Atmel's Flip](http://www.atmel.com/tools/flip.aspx) (not recommended)
+* [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer) / `:dfu` in QMK (recommended command line)
+* [Atmel's Flip](http://www.microchip.com/developmenttools/productdetails.aspx?partno=flip) (not recommended)
 
 Flashing sequence:
 
@@ -53,18 +53,18 @@ To generate a production-ready .hex file (containing the application and the boo
 
 Arduino boards and their clones use the [Caterina bootloader](https://github.com/arduino/Arduino/tree/master/hardware/arduino/avr/bootloaders/caterina) (any keyboard built with a Pro Micro, or clone), and uses the avr109 protocol to communicate through virtual serial. Bootloaders like [A-Star](https://www.pololu.com/docs/0J61/9) are based on Caterina.
 
-To ensure compatability with the Caterina bootloader, make sure this block is present your `rules.mk`:
+To ensure compatibility with the Caterina bootloader, make sure this block is present your `rules.mk`:
 
     # Bootloader
     #     This definition is optional, and if your keyboard supports multiple bootloaders of
-    #     different sizes, comment this out, and the correct address will be loaded 
+    #     different sizes, comment this out, and the correct address will be loaded
     #     automatically (+60). See bootloader.mk for all options.
     BOOTLOADER = caterina
 
 Compatible flashers:
 
 * [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
-* [avrdude](http://www.nongnu.org/avrdude/) with avr109 / `:avrdude` (recommended commandline)
+* [avrdude](http://www.nongnu.org/avrdude/) with avr109 / `:avrdude` (recommended command line)
 * [AVRDUDESS](https://github.com/zkemble/AVRDUDESS)
 
 Flashing sequence:
@@ -82,11 +82,11 @@ or
 
 Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0).
 
-To ensure compatability with the Halfkay bootloader, make sure this block is present your `rules.mk`:
+To ensure compatibility with the Halfkay bootloader, make sure this block is present your `rules.mk`:
 
     # Bootloader
     #     This definition is optional, and if your keyboard supports multiple bootloaders of
-    #     different sizes, comment this out, and the correct address will be loaded 
+    #     different sizes, comment this out, and the correct address will be loaded
     #     automatically (+60). See bootloader.mk for all options.
     BOOTLOADER = halfkay
 
@@ -94,7 +94,7 @@ Compatible flashers:
 
 * [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
 * [Teensy Loader](https://www.pjrc.com/teensy/loader.html)
-* [Teensy Loader Command Line](https://www.pjrc.com/teensy/loader_cli.html) (recommended commandline)
+* [Teensy Loader Command Line](https://www.pjrc.com/teensy/loader_cli.html) (recommended command line)
 
 Flashing sequence:
 
@@ -102,4 +102,3 @@ Flashing sequence:
 2. Wait for the OS to detect the device
 4. Flash a .hex file
 5. Reset the device into application mode (may be done automatically)
-