aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs_flashing.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-25 10:58:36 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commit45e218ceec1269e5e2751146272637922cd7e9d9 (patch)
tree2dd63b29f8c5a9e3751eeb47a17ef25187525f5d /docs/newbs_flashing.md
parent86f6405574d75cdc69c32829cb523aa1538ecd77 (diff)
downloadqmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.tar.gz
qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.zip
overhaul the newbs guide
Diffstat (limited to 'docs/newbs_flashing.md')
-rw-r--r--docs/newbs_flashing.md22
1 files changed, 3 insertions, 19 deletions
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
index 3cbeb1c4b..b114a6247 100644
--- a/docs/newbs_flashing.md
+++ b/docs/newbs_flashing.md
@@ -6,7 +6,7 @@ Now that you've built a custom firmware file you'll want to flash your keyboard.
6 6
7The simplest way to flash your keyboard will be with the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). 7The simplest way to flash your keyboard will be with the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases).
8 8
9However, the QMK Toolbox is only available for Windows and macOS currently. If you're using Linux (or just wish to flash the firmware from the command line), you'll have to use the [method outlined below](newbs_flashing.md#flash-your-keyboard-from-the-command-line). 9However, the QMK Toolbox is only available for Windows and macOS currently. If you're using Linux (or just wish to flash the firmware from the command line), proceed down to [Flash Your Keyboard From The Command Line](newbs_flashing.md#flash-your-keyboard-from-the-command-line).
10 10
11### Load The File Into QMK Toolbox 11### Load The File Into QMK Toolbox
12 12
@@ -100,26 +100,10 @@ However, this does rely on the bootloader being set by the keyboard. If this in
100 100
101 WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time. 101 WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time.
102 102
103In this case, you'll have to fall back on specifying the bootloader. 103In this case, you'll have to fall back on specifying the bootloader. See the [Flashing Firmware](flashing.md) Guide for more details.
104
105There are five main bootloaders that are used. Pro Micro and clones use Caterina, Teensys use HalfKay, OLKB's AVR boards use QMK-DFU, other ATmega32U4 boards use DFU, and most ARM boards use ARM DFU.
106
107You can find more information about the bootloaders in the [Flashing Instructions and Bootloader Information](flashing.md) page.
108
109If you know what bootloader that you're using you can specify that in your flash command:
110
111 qmk flash -bl <bootloader>
112
113Run this command to get a list of valid bootloaders:
114
115 qmk flash --bootloaders
116
117### More information
118
119See the Flashing documentation for more information on esoteric flashing situations.
120 104
121## Test It Out! 105## Test It Out!
122 106
123Congrats! Your custom firmware has been programmed to your keyboard! 107Congrats! Your custom firmware has been programmed to your keyboard!
124 108
125Give it a try and make sure everything works the way you want it to. We've written [Testing and Debugging](newbs_testing_debugging.md) to round out this Newbie Guide, so head over there to learn about validating your firmware and how to troubleshoot your custom functionality. 109Give it a try and make sure everything works the way you want it to. We've written [Testing and Debugging](newbs_testing_debugging.md) to round out this guide, so head over there to learn about validating your firmware and how to troubleshoot your custom functionality.