Skip to content

Commit

Permalink
[Docs] Clean up docs/newbs_flashing.md (qmk#6973)
Browse files Browse the repository at this point in the history
* [Docs] Clean up docs/newbs_flashing.md

See qmk#6930

* Fix typo
  • Loading branch information
Maxr1998 authored and noroadsleft committed Oct 9, 2019
1 parent ceb5345 commit 4b80053
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions docs/newbs_flashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 4b80053

Please sign in to comment.