Skip to content

Update README with animation features#54

Merged
bjmorgan merged 4 commits intomainfrom
update-readme
Apr 4, 2026
Merged

Update README with animation features#54
bjmorgan merged 4 commits intomainfrom
update-readme

Conversation

@bjmorgan
Copy link
Copy Markdown
Owner

@bjmorgan bjmorgan commented Apr 4, 2026

Summary

  • Add trajectory animations and per-frame colouring to the features list
  • Document the animation optional extra for GIF/MP4 export
  • Add animations page to the documentation links

Copilot AI review requested due to automatic review settings April 4, 2026 06:44
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the project README to reflect and link to existing animation functionality in the documentation, including how to install the animation optional extra.

Changes:

  • Add “Trajectory animations (GIF, MP4) with per-frame colouring” to the README feature list.
  • Document installation of the hofmann[animation] optional extra for GIF/MP4 export.
  • Add a README documentation link to the Animations docs page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bjmorgan added 2 commits April 4, 2026 07:45
Update the introductory sentence in README, index.rst, and
getting-started.rst to mention animations alongside static output.
Add imageio-ffmpeg to the requirements lists and cross-reference
render_animation in getting-started.rst.
Copilot AI review requested due to automatic review settings April 4, 2026 06:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bjmorgan bjmorgan merged commit 0c2c902 into main Apr 4, 2026
9 checks passed
@bjmorgan bjmorgan deleted the update-readme branch April 4, 2026 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants