python-uflash
=============

Obtaining the source
--------------------

The uflash source is obtained from Github. At the time of writing upstream
do not tag releases, so a tarball of the latest release is manually downloaded
to e.g. uflash-1.2.4.tar.gz for repacking. A watch file is provided so that new
releases can be automatically downloaded and repacked when tags are available.


Repacking the source
--------------------

The upstream source is repacked to remove non-DFSG files:

 * a pre-compiled MicroPython runtime, firmware.hex
 * a copy of the stringified runtime in uflash.py

A repacking script is provided in debian/repack.sh

To repack an upstream tarball downloaded from Github, use the following:

  $ sh debian/repack.sh --upstream-source 1.2.4 ../uflash-1.2.4.tar.gz

This will repack the upstream tarball and generate a new DFSG-compatible
source tarball in ../python-uflash_1.2.4+dfsg.orig.tar.gz ready for
importing with `gbp import-orig ...`


Obtaining the MicroPython runtime
---------------------------------

The python-uflash source package provides the convenience package
firmware-microbit-micropython-dl that downloads the current
upstream MicroPython runtime from the uflash repository and installs
it to /usr/share/firmware-microbit-micropython/firmware.hex.

A sourceful package for the MicroPython runtime is currently being developed,
along with the associated ARM mbed build system, and will replace this package
when available in the archive.


 -- Nick Morrott <knowledgejunkie@gmail.com>  Wed, 19 Dec 2018 23:48:00 +0000
