diff options
| author | Max Rumpf <max.rumpf1998@gmail.com> | 2019-10-09 06:55:44 +0200 |
|---|---|---|
| committer | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2019-10-08 21:55:44 -0700 |
| commit | 1c07d4e7efd4d0bc3c9baa876987690de56ac715 (patch) | |
| tree | 1a1ebb4454aaa2be2078420ca1e61dabc31bdab3 /docs | |
| parent | 0ea4e861753dec47533b7f56f850d766b496c133 (diff) | |
[Docs] Clean up docs/newbs_flashing.md (#6973)
* [Docs] Clean up docs/newbs_flashing.md
See #6930
* Fix typo
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/newbs_flashing.md | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md index fa21709763..9c76f5592d 100644 --- a/docs/newbs_flashing.md +++ b/docs/newbs_flashing.md @@ -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. |