Mmastodon first seen 3 d ago, last 2 d ago, peak #4
Terence Eden on how to actually test your README
Original: How to *actually* test your readme
Blogger Terence Eden argues that most open-source READMEs are never truly tested by their own authors. He walks through the typical Linux install experience: following the README step by step, only to hit missing instructions on unpacking archives, running setup scripts, or hidden prerequisites. His point is that developers should verify documentation the way a new user would, rather than assume it works.
Why now: The practical advice on documenting open-source projects resonates with developers who routinely struggle with poorly tested install instructions.
Rank over time, top of the chart is #1. 116 snapshots from 3 d ago to 2 d ago.
Evidence
- How to *actually* test your readme · Terence Eden’s Blog
If you've spent any time using Linux, you'll be used to installing software like this: The README says to download from this link. Huh, I'm not sure how to unarchive .tar.xz files - guess I'll search for that. Right, it says run setup.sh hmm, that doesn't work. Oh, I need to…
API: https://socialmediatrends-api.osmike.com/v1/trends/1363628