Readme¶
Generate and update the repository README addon table.
Modules:
| Name | Description |
|---|---|
update |
Generate the addons table in the README.md of the project. |
oops readme update¶
Generate the addons table in the README.md of the project.
The exclusion list uses a start and end tags to identify the section to update. The tags are the following:
- start: # [//]: # (addons)
- end: # [//]: # (end addons)
If the tags are not found in the file, they are automatically added at the end of the file with its content.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--dry-run |
boolean | Show what would happen, do nothing. | False |
--no-commit |
boolean | Do not commit changes. | False |
--help |
boolean | Show this message and exit. | False |
Examples:
Update the addons table and commit if changed:
Update without committing: