Readme¶
oops-readme-update¶
This script replaces markers in the README.md file of an repository with the list of addons present in the repository. It preserves the marker so it can be run again.
Markers in README.md must have the form:
does not matter, will be replaced by the script
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--commit / --no-commit |
boolean | git commit changes to README.rst, if any. | True |
--help |
boolean | Show this message and exit. | False |
Examples:
Update the addons table and commit if changed:
Update without committing: