Mmastodon first seen 1 d ago, last 37 min 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 software README files are never tested from a fresh user's perspective, leading to common install failures with Linux packages. Writing on his blog, he walks through a typical experience of following README instructions and hitting roadblocks, from unarchiving .tar.xz files to broken setup scripts, and urges developers to verify their documentation actually works.
Why now: Developers widely recognise the frustration of broken install instructions, making the practical advice resonate.
Rank over time, top of the chart is #1. 116 snapshots from 1 d ago to 37 min 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