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

[Docs] Clean up docs/newbs_flashing.md (#6973)

Browse source 
* [Docs] Clean up docs/newbs_flashing.md

See #6930

* Fix typo
This commit is contained in:
Max Rumpf 2019-10-09 06:55:44 +02:00 committed by noroadsleft
parent 0ea4e86175
commit 1c07d4e7ef
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/newbs_flashing.md
View file

@ -12,23 +12,31 @@ However, the QMK Toolbox is only available for Windows and macOS currently. If
Begin by opening the QMK Toolbox application. You'll want to locate the firmware file in Finder or Explorer. Your keyboard firmware may be in one of two formats- `.hex` or `.bin`. QMK tries to copy the appropriate one for your keyboard into the root `qmk_firmware` directory.
?> If you are on Windows or macOS there are commands you can use to easily open the current firmware folder in Explorer or Finder.
If you are on Windows or macOS there are commands you can use to easily open the current firmware folder in Explorer or Finder.
?> Windows:
#### Windows
start .
```
start .
```
?> macOS:
#### macOS
open .
```
open .
```
The firmware file always follows this naming format:
<keyboard_name>_<keymap_name>.{bin,hex}
```
<keyboard_name>_<keymap_name>.{bin,hex}
```
For example, the `plank/rev5` with a `default` keymap will have this filename:
For example, the `planck/rev5` with a `default` keymap will have this filename:
planck_rev5_default.hex
```
planck_rev5_default.hex
```
Once you have located your firmware file drag it into the "Local file" box in QMK Toolbox, or click "Open" and navigate to where your firmware file is stored.