kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): Note that UF2 drive unmounts after flashing (#1859)

Browse source 
Add a note about the UF2 drive that automatically unmounts itself
to restart, which may surprise some new users.
This commit is contained in:
フィルターペーパー 2023-07-07 01:39:08 +08:00 • committed by GitHub
parent 3772ecb04e
commit bbb27ac027
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/development/build-flash.md
View file

@ -130,8 +130,8 @@ The above build commands generate a UF2 file in `build/zephyr` (or
`build/left|right/zephyr` if you followed the instructions for splits) and is by `build/left|right/zephyr` if you followed the instructions for splits) and is by
default named `zmk.uf2`. If your board supports USB Flashing Format (UF2), copy default named `zmk.uf2`. If your board supports USB Flashing Format (UF2), copy
that file onto the root of the USB mass storage device for your board. The that file onto the root of the USB mass storage device for your board. The
controller should flash your built firmware and automatically restart once controller should flash your built firmware, unmount the USB storage device and
flashing is complete. automatically restart once flashing is complete.
Alternatively, if your board supports flashing and you're not developing from Alternatively, if your board supports flashing and you're not developing from
within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on

5
docs/docs/user-setup.md
View file

@ -198,8 +198,9 @@ To flash the firmware, first put your board into bootloader mode by double click
or the one that is part of your keyboard). The controller should appear in your OS as a new USB storage device. or the one that is part of your keyboard). The controller should appear in your OS as a new USB storage device.
Once this happens, copy the correct UF2 file (e.g. left or right if working on a split), and paste it onto the root of that USB mass Once this happens, copy the correct UF2 file (e.g. left or right if working on a split), and paste it onto the root of that USB mass
storage device. Once the flash is complete, the controller should automatically restart, and load your newly flashed firmware. It is storage device. Once the flash is complete, the controller should unmount the USB storage, automatically restart and load your newly
recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to connect to it wirelessly. flashed firmware. It is recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to
connect to it wirelessly.
:::caution Split keyboards :::caution Split keyboards