kmk_firmware/docs/flashing.md

36 lines
1.4 KiB
Markdown
Raw Normal View History

2018-10-11 19:06:10 -07:00
# Flashing Instructions
2019-07-24 21:24:22 -07:00
In general, we recommend using the instructions in `README.md`, however, mostly
as a development artifact, another method of flashing KMK exists (tested and
supported only on Linux, though it should also work on MacOS, the BSDs, and
other Unix-likes. It may also work on Cygwin and the Windows Subsystem for
Linux).
2019-07-24 21:24:22 -07:00
Given `make` and `rsync` are available on your system (in `$PATH`), the
following will copy the `kmk` tree to your CircuitPython device, and will copy
the file defined as `USER_KEYMAP` as your `main.py`. If any of these files exist
on your CircuitPython device already, they will be overwritten without a prompt.
2019-07-24 21:24:22 -07:00
If you get permissions errors here, **don't run make as root or with sudo**. See
`Troubleshooting` below.
```sh
2019-07-24 21:24:22 -07:00
make MOUNTPOINT=/media/CIRCUITPY USER_KEYMAP=user_keymaps/nameofyourkeymap.py
```
# Troubleshooting
## Linux/BSD
2019-07-24 21:24:22 -07:00
Check to see if your drive may have mounted elsewhere with a GUI tool or other
automounter. Most of these tools will mount your device under `/media`, probably
as `/media/CIRCUITPY`. If it's not mounted, you can read up on how to mount a
drive manually
[here](https://wiki.archlinux.org/index.php/File_systems#Mount_a_file_system).
For example,
2019-07-24 21:24:22 -07:00
`sudo mount -o uid=$(id -u),gid=$(id -g) /dev/disk/by-label/CIRCUITPY ~/mnt`
2019-07-24 21:24:22 -07:00
If you're still having issues, check out our support page to see where you can
come say hi and the community will gladly help you out.