Skip to content

Optimise README assets and improve load performance #37

@Shaadalam9

Description

@Shaadalam9

Summary

The README is currently too slow to load and, in some cases, does not finish loading at all. This appears to be caused mainly by very large embedded PNGs and GIFs. That makes the repository harder to show to others and reduces the usefulness of the README.

Problem

The README includes several large media files, especially GIFs, which make the page unacceptably slow to load. Setting width="100%" only changes display size in the browser and does not reduce the actual file size downloaded by the user.

Why this matters

Multiple times, the README has been too slow to load when trying to show it to other people. This is counter productive and needs to be fixed before the final version.

Tasks

  • Measure current README load performance using the browser Network tab in Chrome DevTools
  • Repeat the same check in Firefox using the Network tab
  • Identify the heaviest assets and their load times
  • Reduce the dimensions and file sizes of PNG figures used in the README
  • Replace or compress very large GIFs, especially those around tens of MB
  • Consider replacing embedded GIFs with:
    • static preview images linked to YouTube, or
    • short MP4 or WebM clips if appropriate
  • Re test README loading after optimisation
  • Confirm that the README loads reliably on a normal connection

Candidate media to review

  • ./readme/output.gif
  • ./readme/ghost.gif
  • ./readme/camera_move.gif
  • ./readme/shaking.gif
  • ./readme/parking.gif
  • ./readme/video_in_video.gif

Suggested outcome

The final README should:

  • load reliably and quickly
  • avoid oversized embedded media
  • remain easy to browse and present to others
  • preserve examples while using lighter assets

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions