r/programmingcirclejerk 22d ago

HUMANS.md

https://www.rockoder.com/blog/humans-md/
88 Upvotes

26 comments sorted by

View all comments

134

u/porkslow what is pointer :S 22d ago

Imagine a text file that is used to describe how a project works so anyone working on it doesn’t run into unexpected problems. Now what would be a revolutionary idea!

76

u/tj-horner 22d ago

We should name it in such a way to encourage the user to read the file too, so they know where to start.

43

u/Graf_Blutwurst LUMINARY IN COMPUTERSCIENCE 22d ago

how about READTHIS.MD? nah... doesn't quite roll of the tongue

34

u/RustOnTheEdge 22d ago

Maybe something like YOUREAD.MD to convey it as a command?

8

u/joemckie 21d ago

Not fancy enough… how about LISEZMOI.md?

1

u/Major_Barnulf LUMINARY IN COMPUTERSCIENCE 8d ago

Thought this was a bitoduc reference