esp-flasher-stub

This project is experimental and not yet ready for production use.

The project's goal is to replace the legacy flasher stub of esptool in the near future.

How To Use

1. Install esptool in development mode.
2. Obtain the flasher stub binaries as JSON files either from the releases page or from the artifacts of your pull request.
3. Replace the esptool's JSONs files in the esptool/targets/stub_flasher directory with the obtained JSON files.

Contributing

Please install the pre-commit hooks to ensure that your commits are properly formatted:

pip install pre-commit
pre-commit install -t pre-commit -t commit-msg

How To Release (For Maintainers Only)

pip install commitizen
git fetch
git checkout -b update/release_v1.1.0
git reset --hard origin/master
cz bump
git push -u
git push --tags

Create a pull request and edit the automatically created draft release notes.

License

This document and the attached source code are released as Free Software under either the Apache License Version 2 or MIT License at your option.