Mmastodon TechnologySoftware first seen 10 h ago, last 10 h ago, peak #1

Developers urged to actually test their README instructions

Original: If you publish any # OpenSource and you want people to use it, may I please implore you to test your README? Can you act

A developer has issued a public plea to open source maintainers: test the installation steps in your README before publishing. The argument is that many projects include instructions that only work on the author's own machine, failing for users who lack the same development packages. Other developers are likely to agree, as broken setup documentation is a common frustration when trying new open source tools.

Why now: Broken or untested README instructions are a widespread, relatable annoyance for anyone installing open source software.

open source communityEdent

Open on mastodon →

Evidence

• If you publish any # OpenSource and you want people to use it, may I please implore you to test your README? Can you actually follow the steps you've written down? Does it work if the user doesn't have the same development packages installed as you? https://… · Edent · 42

API: https://socialmediatrends-api.osmike.com/v1/trends/1357725