diff options
Diffstat (limited to 'docs/newbs_flashing.md')
-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 fa2170976..9c76f5592 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 | |||
12 | 12 | ||
13 | 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. | 13 | 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. |
14 | 14 | ||
15 | ?> If you are on Windows or macOS there are commands you can use to easily open the current firmware folder in Explorer or Finder. | 15 | If you are on Windows or macOS there are commands you can use to easily open the current firmware folder in Explorer or Finder. |
16 | 16 | ||
17 | ?> Windows: | 17 | #### Windows |
18 | 18 | ||
19 | start . | 19 | ``` |
20 | start . | ||
21 | ``` | ||
20 | 22 | ||
21 | ?> macOS: | 23 | #### macOS |
22 | 24 | ||
23 | open . | 25 | ``` |
26 | open . | ||
27 | ``` | ||
24 | 28 | ||
25 | The firmware file always follows this naming format: | 29 | The firmware file always follows this naming format: |
26 | 30 | ||
27 | <keyboard_name>_<keymap_name>.{bin,hex} | 31 | ``` |
32 | <keyboard_name>_<keymap_name>.{bin,hex} | ||
33 | ``` | ||
28 | 34 | ||
29 | For example, the `plank/rev5` with a `default` keymap will have this filename: | 35 | For example, the `planck/rev5` with a `default` keymap will have this filename: |
30 | 36 | ||
31 | planck_rev5_default.hex | 37 | ``` |
38 | planck_rev5_default.hex | ||
39 | ``` | ||
32 | 40 | ||
33 | 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. | 41 | 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. |
34 | 42 | ||