Skip to content

README: refresh the demo GIF and illustrate both views - #3

Merged
necco-c merged 2 commits into
mainfrom
readme-gifs
Aug 19, 2026
Merged

README: refresh the demo GIF and illustrate both views#3
necco-c merged 2 commits into
mainfrom
readme-gifs

Conversation

@necco-c

@necco-c necco-c commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #2, which merged before this commit landed on the branch. Rebased onto current main.

Changes

  • Hero GIF replaced with today's recording. Kept at assets/hotspot.gif so the existing reference and any external links to that path stay valid. Alt text rewritten: the old one described "a per-frame hover tooltip", but the new recording shows the flame view of bash transitioning to the flat table.
  • "What you're looking at" now shows real captures instead of hand-written ASCII mockups: assets/hotspot-process.gif for the process table, assets/hotspot-flat-profile.gif for the flat profile.

Why the mockups had to go

They had drifted from real output: a 214-process host, invented sample counts, and a postgresql/16 path. The actual captures show 54 processes and postgresql/17. The prose that follows (header / status line / table / legend, and the column table) already described what the captures show, so it needed no edits.

Each GIF was checked frame-by-frame against its filename before writing alt text: process table with dockerd selected; flat profile of postgres with kernel frames tinted purple and the object legend along the bottom. All three are 1222x635; assets/ totals 2.6M.

Tradeoff worth a look: the ASCII blocks were greppable and readable in plain text, and the GIFs aren't. Happy to restore the fences alongside the images, with the numbers corrected, if you'd rather keep both.

Also verified

Now that the repo is public, I re-ran the one-liner #2 documents, from a clean cache on Debian 13 / yeet 0.21.0:

yeet run gh:yeet-src/hotspot --tty

It clones anonymously, runs make in yeet's cache (toolchain fetched, no consent prompt), and renders the live process table. The claim in the merged README holds.

No em-dashes added.

Replace the hero GIF with today's recording, and swap the two hand-written
ASCII mockups under "What you're looking at" for real captures of the
process table and the flat profile. The mockups had drifted from the actual
output (invented sample counts, a 214-process host, a 16.x postgres path);
the captures show what the script really renders.
yeet run resolves tty mode from stdout().is_terminal() when neither
--tty nor --no-tty is given, so every documented invocation gets a PTY
without the flag. Carrying it in the docs implied it was required.

Rewrite the --  placement note to cite --quiet/--watch instead, since it
used --tty as its example of a runtime-side flag.
@necco-c
necco-c merged commit c0fbf65 into main Aug 19, 2026
5 checks passed
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.

1 participant