diff --git a/tools/updater/README.md b/tools/updater/README.md index bff19bb7e..01e0cfea3 100644 --- a/tools/updater/README.md +++ b/tools/updater/README.md @@ -7,3 +7,10 @@ When the script is finished running, you will need to reset the device by pressi switch inside the hole in the lower right hand side of the case. See https://ci.betrusted.io/i/reset.jpg for an example of how to do this. See our [troubleshooting](https://github.com/betrusted-io/betrusted-wiki/wiki/Updating-Your-Device#troubleshooting) guide for more help, especially if you are running Windows. + +# Maintainer Notes + +The repo is structured to use `setup.py`, so the first hits for documentation that guide you through using the `toml` manifest options won't work (couldn't get them to work anyways, even though I tried with the toml method). Thus, the method to push a new release is as follows: + +1. Run `python3 setup.py sdist` in this directory +2. Run `python3 -m twine upload dist/precursorupdater-0.0.XXX.tar.gz` where XXX is replaced with the version number.