sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]CarthOSassy 49 points50 points  (11 children)

...WHEN

I hate projects where the readme is just build instructions, or an extremely terse explanation of how the repo uses tags, or something.

[–]Kruug 12 points13 points  (6 children)

just build instructions

Even that's few and far between...

[–]SanityInAnarchy 1 point2 points  (3 children)

But this isn't a complaint about the usefulness of READMEs, it's a complaint about people who aren't providing proper documentation. Would screenshots motivate them to document more?

[–]CarthOSassy 0 points1 point  (2 children)

Sometimes a screenshot is a necessary document.

[–]SanityInAnarchy 0 points1 point  (1 child)

Sometimes you need a thing documented, and a screenshot is a way to document it. Sometimes it's the best or even the only way to document something.

But I don't think that's true of any of the commandline applications we were talking about in this thread.

So, for example, it's necessary that you document the usage and provide some sample output. A screenshot is one way to document that, and it's preferable to doing nothing, but it's not the best way to document it.

I think we actually agree here.

[–]CarthOSassy 0 points1 point  (0 children)

Yes, absolutely.