summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-09-10 17:17:54 +1000
committerGitHub <noreply@github.com>2021-09-10 17:17:54 +1000
commitd5cb7de5e4ea60dce69764a627358d534af1f666 (patch)
tree5835a4448bbb4e946495aad393145aca39305c75 /docs
parent7eea780a7da2d9197b78b62b7294a6b2bc2fa572 (diff)
Change USBasp and bootloadHID bootloaders to lowercase (#14354)
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md4
-rw-r--r--docs/driver_installation_zadig.md56
-rw-r--r--docs/flashing.md6
-rw-r--r--docs/flashing_bootloadhid.md4
-rw-r--r--docs/getting_started_make_guide.md2
5 files changed, 36 insertions, 36 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 94f99e74c0..7584d3584e 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -397,8 +397,8 @@ However, this will automatically disable the legacy TMK Macros and Functions fea
* `qmk-dfu`
* `halfkay`
* `caterina`
- * `bootloadHID`
- * `USBasp`
+ * `bootloadhid`
+ * `usbasploader`
## Feature Options :id=feature-options
diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md
index 137ec8ad64..9155e56e37 100644
--- a/docs/driver_installation_zadig.md
+++ b/docs/driver_installation_zadig.md
@@ -68,31 +68,31 @@ This is a list of known bootloader devices and their USB vendor and product IDs,
The device name here is the name that appears in Zadig, and may not be what the Device Manager or QMK Toolbox displays.
-|Bootloader |Device Name |VID/PID |Driver |
-|-------------|------------------------------|--------------|-------|
-|`atmel-dfu` |ATmega16u2 DFU |`03EB:2FEF` |libusb0|
-|`atmel-dfu` |ATmega32U2 DFU |`03EB:2FF0` |libusb0|
-|`atmel-dfu` |ATm16U4 DFU V1.0.2 |`03EB:2FF3` |libusb0|
-|`atmel-dfu` |ATm32U4DFU |`03EB:2FF4` |libusb0|
-|`atmel-dfu` |*none* (AT90USB64) |`03EB:2FF9` |libusb0|
-|`atmel-dfu` |AT90USB128 DFU |`03EB:2FFB` |libusb0|
-|`qmk-dfu` |(keyboard name) Bootloader |As `atmel-dfu`|libusb0|
-|`halfkay` |*none* |`16C0:0478` |HidUsb |
-|`caterina` |Pro Micro 3.3V |`1B4F:9203` |usbser |
-|`caterina` |Pro Micro 5V |`1B4F:9205` |usbser |
-|`caterina` |LilyPadUSB |`1B4F:9207` |usbser |
-|`caterina` |Pololu A-Star 32U4 Bootloader |`1FFB:0101` |usbser |
-|`caterina` |Arduino Leonardo |`2341:0036` |usbser |
-|`caterina` |Arduino Micro |`2341:0037` |usbser |
-|`caterina` |Adafruit Feather 32u4 |`239A:000C` |usbser |
-|`caterina` |Adafruit ItsyBitsy 32u4 3V |`239A:000D` |usbser |
-|`caterina` |Adafruit ItsyBitsy 32u4 5V |`239A:000E` |usbser |
-|`caterina` |Arduino Leonardo |`2A03:0036` |usbser |
-|`caterina` |Arduino Micro |`2A03:0037` |usbser |
-|`bootloadHID`|HIDBoot |`16C0:05DF` |HidUsb |
-|`USBasp` |USBasp |`16C0:05DC` |libusbK|
-|`apm32-dfu` |APM32 DFU ISP Mode |`314B:0106` |WinUSB |
-|`stm32-dfu` |STM32 BOOTLOADER |`0483:DF11` |WinUSB |
-|`kiibohd` |Kiibohd DFU Bootloader |`1C11:B007` |WinUSB |
-|`stm32duino` |Maple 003 |`1EAF:0003` |WinUSB |
-|`qmk-hid` |(keyboard name) Bootloader |`03EB:2067` |HidUsb |
+|Bootloader |Device Name |VID/PID |Driver |
+|--------------|------------------------------|--------------|-------|
+|`atmel-dfu` |ATmega16u2 DFU |`03EB:2FEF` |libusb0|
+|`atmel-dfu` |ATmega32U2 DFU |`03EB:2FF0` |libusb0|
+|`atmel-dfu` |ATm16U4 DFU V1.0.2 |`03EB:2FF3` |libusb0|
+|`atmel-dfu` |ATm32U4DFU |`03EB:2FF4` |libusb0|
+|`atmel-dfu` |*none* (AT90USB64) |`03EB:2FF9` |libusb0|
+|`atmel-dfu` |AT90USB128 DFU |`03EB:2FFB` |libusb0|
+|`qmk-dfu` |(keyboard name) Bootloader |As `atmel-dfu`|libusb0|
+|`halfkay` |*none* |`16C0:0478` |HidUsb |
+|`caterina` |Pro Micro 3.3V |`1B4F:9203` |usbser |
+|`caterina` |Pro Micro 5V |`1B4F:9205` |usbser |
+|`caterina` |LilyPadUSB |`1B4F:9207` |usbser |
+|`caterina` |Pololu A-Star 32U4 Bootloader |`1FFB:0101` |usbser |
+|`caterina` |Arduino Leonardo |`2341:0036` |usbser |
+|`caterina` |Arduino Micro |`2341:0037` |usbser |
+|`caterina` |Adafruit Feather 32u4 |`239A:000C` |usbser |
+|`caterina` |Adafruit ItsyBitsy 32u4 3V |`239A:000D` |usbser |
+|`caterina` |Adafruit ItsyBitsy 32u4 5V |`239A:000E` |usbser |
+|`caterina` |Arduino Leonardo |`2A03:0036` |usbser |
+|`caterina` |Arduino Micro |`2A03:0037` |usbser |
+|`bootloadhid` |HIDBoot |`16C0:05DF` |HidUsb |
+|`usbasploader`|USBasp |`16C0:05DC` |libusbK|
+|`apm32-dfu` |APM32 DFU ISP Mode |`314B:0106` |WinUSB |
+|`stm32-dfu` |STM32 BOOTLOADER |`0483:DF11` |WinUSB |
+|`kiibohd` |Kiibohd DFU Bootloader |`1C11:B007` |WinUSB |
+|`stm32duino` |Maple 003 |`1EAF:0003` |WinUSB |
+|`qmk-hid` |(keyboard name) Bootloader |`03EB:2067` |HidUsb |
diff --git a/docs/flashing.md b/docs/flashing.md
index 7b7fe956f3..2e69f246aa 100644
--- a/docs/flashing.md
+++ b/docs/flashing.md
@@ -127,7 +127,7 @@ To ensure compatibility with the USBasploader bootloader, make sure this block i
```make
# Bootloader selection
-BOOTLOADER = USBasp
+BOOTLOADER = usbasploader
```
Compatible flashers:
@@ -153,13 +153,13 @@ To ensure compatibility with the bootloadHID bootloader, make sure this block is
```make
# Bootloader selection
-BOOTLOADER = bootloadHID
+BOOTLOADER = bootloadhid
```
Compatible flashers:
* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
-* [bootloadHID CLI](https://www.obdev.at/products/vusb/bootloadhid.html) / `:bootloadHID` target in QMK (recommended command line)
+* [bootloadHID CLI](https://www.obdev.at/products/vusb/bootloadhid.html) / `:bootloadhid` target in QMK (recommended command line)
* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash)
Flashing sequence:
diff --git a/docs/flashing_bootloadhid.md b/docs/flashing_bootloadhid.md
index 731d927727..9879ec999e 100644
--- a/docs/flashing_bootloadhid.md
+++ b/docs/flashing_bootloadhid.md
@@ -15,9 +15,9 @@ General flashing sequence:
?> Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.
-To flash via the command line, use the target `:bootloadHID` by executing the following command:
+To flash via the command line, use the target `:bootloadhid` by executing the following command:
- make <keyboard>:<keymap>:bootloadHID
+ make <keyboard>:<keymap>:bootloadhid
## GUI Flashing
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index 02216875c8..70390a5105 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -14,7 +14,7 @@ The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`,
The `<target>` means the following
* If no target is given, then it's the same as `all` below
* `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck.
-* `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadHID` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme.
+* `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadhid` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme.
Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders.
* **Note**: some operating systems need privileged access for these commands to work. This means that you may need to setup [`udev rules`](faq_build.md#linux-udev-rules) to access these without root access, or to run the command with root access (`sudo make planck/rev4:default:flash`).
* `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems.