Anki add-on template for my projects.
- My ankiscripts project is used for various tasks, such as setting up dev environment, packaging, and updating dependencies.
- Source files are in the src folder. The add-on zip contains all contents of this folder.
- Qt Designer files (if any) are in designer folder. Generated Python forms are written to src/forms.
- An addon.json file is used for metadata, similar to Glutanimate's add-on builder. manifest.json is produced from this file.
- pylint, mypy, black, and isort are used for linting and formatting.
- Tests are in the tests folder.
- a Makefile is used to run build & lint commands.
- Requirements are specified in *.in files inside the requirements subfolder. pip-tools is used to update and pin dependencies, generating corresponding .txt files.
- CHANGELOG.md follows the Keep a Changelog format.
- The description for the AnkiWeb listing is in ankiweb_page.html. ankiwebify-readme can be used to convert some sections of README.md to the HTML accepted by AnkiWeb.
- The add-on is licensed under GNU AGPLv3.
Below sections are what should be modified and included in the actual add-on's README.md.
[BEGINNING OF TEMPLATE]
See CHANGELOG.md for a list of changes.
Please post any questions, bug reports, or feature requests in the support page or the issue tracker.
If you want priority support for your feature/help request, I'm available for hire. Get in touch via email or the UpWork link below.
Consider supporting me if you like my work:
I'm also available for freelance add-on development:
