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
No known key found for this signature in database
GPG Key ID: A4A0C7B4E8EEE222
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -50,20 +50,21 @@ dist-deploy: devdeps dist
@[[ -n "$${CIRCLE_TAG}" ]] && $(PIPENV) run s3cmd -c .s3cfg put -P dist/kmk-latest.zip s3://kmk-releases/$${CIRCLE_TAG}.zip >/dev/null || true @[[ -n "$${CIRCLE_TAG}" ]] && $(PIPENV) run s3cmd -c .s3cfg put -P dist/kmk-latest.zip s3://kmk-releases/$${CIRCLE_TAG}.zip >/dev/null || true
@[[ -n "$${CIRCLE_TAG}" ]] && $(PIPENV) run s3cmd -c .s3cfg put -P dist/kmk-latest.unoptimized.zip s3://kmk-releases/$${CIRCLE_TAG}.unoptimized.zip >/dev/null || true @[[ -n "$${CIRCLE_TAG}" ]] && $(PIPENV) run s3cmd -c .s3cfg put -P dist/kmk-latest.unoptimized.zip s3://kmk-releases/$${CIRCLE_TAG}.unoptimized.zip >/dev/null || true
dist/kmk-latest.zip: compile dist/kmk-latest.zip: compile boot.py
@echo "===> Building optimized ZIP" @echo "===> Building optimized ZIP"
@mkdir -p dist @mkdir -p dist
@cd $(MPY_TARGET_DIR) && zip -r ../dist/kmk-latest.zip kmk 2>&1 >/dev/null @cd $(MPY_TARGET_DIR) && zip -r ../dist/kmk-latest.zip kmk 2>&1 >/dev/null
@zip -r dist/kmk-latest.zip boot.py 2>&1 >/dev/null
dist/$(DIST_DESCRIBE).zip: dist/kmk-latest.zip dist/$(DIST_DESCRIBE).zip: dist/kmk-latest.zip
@echo "===> Aliasing optimized ZIP" @echo "===> Aliasing optimized ZIP"
@cp dist/kmk-latest.zip dist/kmk-$(DIST_DESCRIBE).zip @cp dist/kmk-latest.zip dist/kmk-$(DIST_DESCRIBE).zip
dist/kmk-latest.unoptimized.zip: $(PY_KMK_TREE) dist/kmk-latest.unoptimized.zip: $(PY_KMK_TREE) boot.py
@echo "===> Building unoptimized ZIP" @echo "===> Building unoptimized ZIP"
@mkdir -p dist @mkdir -p dist
@echo "KMK_RELEASE = '$(DIST_DESCRIBE)'" > kmk/release_info.py @echo "KMK_RELEASE = '$(DIST_DESCRIBE)'" > kmk/release_info.py
@zip -r dist/kmk-latest.unoptimized.zip kmk 2>&1 >/dev/null @zip -r dist/kmk-latest.unoptimized.zip kmk boot.py 2>&1 >/dev/null
@rm -rf kmk/release_info.py @rm -rf kmk/release_info.py
dist/$(DIST_DESCRIBE).unoptimized.zip: dist/kmk-latest.unoptimized.zip dist/$(DIST_DESCRIBE).unoptimized.zip: dist/kmk-latest.unoptimized.zip

4
README.md
View File

@ -86,7 +86,9 @@ Coming (hopefully) soon: Bluetooth support! Stay tuned.
extract the zip to the USB drive exposed by CircuitPython, typically labeled extract the zip to the USB drive exposed by CircuitPython, typically labeled
`CIRCUITPY`. Again, [we'll defer to Adafruit's `CIRCUITPY`. Again, [we'll defer to Adafruit's
documentation](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries) documentation](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries)
on adding libraries to a CircuitPython installation. on adding libraries to a CircuitPython installation. You should end up with a
folder called `kmk` and a file called `boot.py`, both living at the top of
this USB drive.
- Define your keyboard in a file called `main.py` on this `CIRCUITPY` drive and - Define your keyboard in a file called `main.py` on this `CIRCUITPY` drive and
get tinkering! Examples of both handwired and ProMicro-\>ItsyBitsy converted get tinkering! Examples of both handwired and ProMicro-\>ItsyBitsy converted

7
docs/flashing.md
View File

@ -8,8 +8,11 @@ Linux).
Given `make` and `rsync` are available on your system (in `$PATH`), the 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 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 the file defined as `USER_KEYMAP` as your `main.py`. It will also copy our
on your CircuitPython device already, they will be overwritten without a prompt. `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 If you get permissions errors here, **don't run make as root or with sudo**. See
`Troubleshooting` below. `Troubleshooting` below.