Skip to content

docs: rebuild the readme around the comparison clip - #9

Merged
kaffeindecaf merged 1 commit into
mainfrom
docs/readme-gallery
Oct 28, 2026
Merged

kaffeindecaf merged 1 commit into
mainfrom
docs/readme-gallery

Conversation

@kaffeindecaf

Copy link
Copy Markdown
Owner

what

  • centered hero: title, tagline, ci/python/ffmpeg/platform badges and jump links
  • inline gif preview of catcomparison.mp4 (one clip, four runs: normal,
    blockswap, causality + timescratch + stutter, rgb bending + crt); the gif links
    to the full 17 s clip, which is now committed at the repo root
  • effects section rebuilt: an index table generated from effex --list --json
    (so it cannot drift from the code), grouped like the picker, with one
    collapsible option table per single-pass effect and every existing deep dive
    kept verbatim
  • new key-reference table, cli flag table, chains section and a development
    file map; install, logging and test notes tightened into short sections

verified

  • link/anchor check: 14 in-page links resolve, both asset links exist, 66 code
    fences balanced, 18 details blocks opened and closed
  • rendered the markdown and eyeballed hero, key table, effects index, collapsed
    effects, install tables and the collapse deep dive
  • no code touched: tests/run_tests.py unaffected

- hero block, badges, nav and an inline gif that links to the full
  catcomparison.mp4, with the four looks labelled from the clip itself
- effects section: an index table generated from effex --list --json, grouped
  the way the picker groups them, plus one collapsible option table per
  single-pass effect and the existing deep dives kept intact
- new key reference, cli flag table, and a development file table
- install, logs and chain notes rewritten as short sections with tables
@kaffeindecaf
kaffeindecaf merged commit c0b0f29 into main Oct 28, 2026
2 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