sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

boot.py is still required - ensure it ends up in our dists and is documented

Browse Source
This commit is contained in:
Josh Klar
2019-07-24 23:28:13 -07:00
parent 6b73a5ec56
commit 4bdf926360
3 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/flashing.md
View File

@@ -8,8 +8,11 @@ Linux).
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.
the file defined as `USER_KEYMAP` as your `main.py`. It will also copy our
`boot.py`, which allocates a larger stack size (simply - more of the device's
RAM will be available to KMK and your keyboard config) than CircuitPython's
default. If any of these files exist on your CircuitPython device already, they
will be overwritten without a prompt.
If you get permissions errors here, **don't run make as root or with sudo**. See
`Troubleshooting` below.