Back to browse
GitHub Repository

Run the console blocks in your README and check they still tell the truth -- I audited eight of my own repos and four of them lied

0 starsPython

I audited my own eight repos. Half of them lied in the README

by Wasserpuncher·Jul 14, 2026·1 point·0 comments

AI Analysis

●●SolidBig BrainSolve My Problem

Automates the painful manual chore of keeping README code examples and benchmarks honest.

Strengths
  • Smart fuzzy matching ignores timestamps and dots so valid docs don't fail unnecessarily.
  • Tilde syntax for benchmarks explicitly acknowledges hardware variance instead of hiding it.
  • Catches the specific embarrassment of publishing stale benchmarks or fake test results.
Weaknesses
  • Requires a specific environment setup to run safely without side effects on the host machine.
  • Niche utility only matters to maintainers who care deeply about documentation accuracy.
Target Audience

Open source maintainers, library authors, technical writers

Similar To

mdtest · docca · pytest-doctest

Similar Projects