Development

Use the latest version of Rust.

Run tests:
- cargo test
Activate pre-commit hooks (requires Python) to handle formatting/linting:
```
pip install --user pre-commit
pre-commit install
```

Generate docs (requires Python):

pip install --user invoke tomli
invoke docs

Release

Commands assume you are using Git Bash on Windows:

pip install invoke
cargo install cargo-lichking

Update version in CHANGELOG.md
Update version in Cargo.toml
Run invoke prerelease
Run git add for all relevant changes
Run invoke release
- This will create a new commit/tag and push them.
- Manually create a release on GitHub and attach the workflow build artifacts (plus dist/*-legal.zip).
Run cargo publish
Run invoke release-winget
- When the script opens VSCode and pauses, manually edit manifests/m/mtkennerly/shawl/${VERSION}/mtkennerly.shawl.locale.en-US.yaml to add the ReleaseNotes and ReleaseNotesUrl fields:
```
ReleaseNotes: |-
  <copy/paste from CHANGELOG.md>
ReleaseNotesUrl: https://github.com/mtkennerly/shawl/releases/tag/v${VERSION}
```
  Close the file, and the script will continue.
- This will automatically push a branch to a fork of https://github.com/microsoft/winget-pkgs .
- Manually open a pull request for that branch.