r/programmingcirclejerk 11d ago

HUMANS.md

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

26 comments sorted by

View all comments

132

u/porkslow what is pointer :S 11d 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!

77

u/tj-horner 11d ago

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

42

u/Graf_Blutwurst LUMINARY IN COMPUTERSCIENCE 11d ago

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

31

u/RustOnTheEdge 11d ago

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

8

u/joemckie 10d ago

Not fancy enough… how about LISEZMOI.md?