Skip to content

animated GIFs are suboptimal for documentation, including README #40

@TallTed

Description

@TallTed

For example, this gif in the README.md.

The longer the display period, the less optimal a GIF is.

Yes, they can be quick and easy for the producer to make, but there are often significant prices paid by the consumer.

Most obviously, there's no pause, rewind, nor fast-forward... Which means that one has to watch from the start, no matter what segment they're trying to re-view. It's also impossible to know where you are in the animation, so it's not possible to simply restart, nor even to "watch for the restart" — unless the creator of the GIF inserts several key frames at start and/or end, which the viewer can watch for once (if) they notice they exist.

I suggest converting any such animated GIFs to MPEG-4/MP4 using H.264 (optimally, as it appears to be universally supported by current browsers and OS) or HTML5/WebM (suboptimally, as it appears to be not-quite-universally supported, though this is continuing to change for the better), for both of which there are a number of online and local converters, many of which are free of charge.

Adding some voice-over that describes what's being shown would also be a good thing for accessibility (a11y), as the current silent animations cannot be consumed well if at all by anyone with visual impairments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions