Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Oct 9, 2019
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e154f0
[Docs] Clean up docs/newbs_flashing.md
Maxr1998 Oct 8, 2019
69eef98
Fix typo
Maxr1998 Oct 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions docs/newbs_flashing.md
View file
Open in desktop
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