Shows the example run in colour - #60
Open
johnnyt wants to merge 1 commit into
Open
Conversation
johnnyt
force-pushed
the
readme-colour-example
branch
from
August 2, 2026 14:35
8ecfaba to
4d0030d
Compare
johnnyt
changed the title
A fenced code block cannot carry ANSI, so the README's example output showed the shape of a run but not the green, dim and red that 0.13.0 added. It is an SVG now, hand-written to match what Printer emits rather than screenshotted, with a line saying the colour is a second channel over the glyph and is dropped off a terminal. The image is referenced by absolute URL, so it does not join the package files and the tarball every dependent downloads is unchanged.
johnnyt
force-pushed
the
readme-colour-example
branch
from
August 2, 2026 14:37
4d0030d to
1384f64
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
0.13.0 added colour to the stage status lines, but the README's example output
is a fenced code block, and neither GitHub nor HexDocs renders ANSI inside one.
The section called "The output is the point" was showing the shape of a run
without the thing the release changed.
It is an SVG now. Hand-written rather than screenshotted, so the colours are
the ones
ExQuality.Printeractually emits (green tick and stage name, dimskip line, red failure via
Mix.Shell.IO.error/1) and the findings below stayuncoloured because
Finding.render/1does not colour them.A line under the image says colour is a second channel over the
✓/○/✗andis dropped when the output is not a terminal, so nobody reads the image as a
promise about CI logs.
The image is referenced by absolute
raw.githubusercontent.comURL. That is thesame reasoning as the guide links in #58: hex.pm resolves a README's relative
paths against the tarball, so a relative reference would have to ship in
files:and grow the download for every dependent.mix.exshas a note to thateffect now, since its existing comment claimed the mark was the only asset the
README referenced.
Rendered check of the SVG is attached below - padding, glyph rendering and the
monospace column all verified at the committed size (732x464).