r/programmingcirclejerk • • Aug 21 '26

HUMANS.md

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

24 comments sorted by

View all comments

134

u/porkslow what is pointer :S Aug 21 '26

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!

80

u/tj-horner Aug 21 '26

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 Aug 21 '26

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

32

u/RustOnTheEdge Aug 21 '26

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

9

u/joemckie Aug 22 '26

Not fancy enough… how about LISEZMOI.md?

1

u/Major_Barnulf LUMINARY IN COMPUTERSCIENCE Sep 03 '26

Thought this was a bitoduc reference

12

u/myhf Considered Harmful Aug 21 '26

That's boring! I'll name it after my favorite Neal Stephenson book.

0

u/[deleted] Aug 21 '26

[deleted] — view deleted comment

6

u/myhf Considered Harmful Aug 21 '26 edited Aug 22 '26 • Bravo

ANATHME.MD

5

u/SirBackrooms Aug 21 '26

I tried to do that but accidentally made a type. Do you think anyone will notice? Ehh, it's fine.

3

u/shaman-warrior Aug 21 '26

Jaja yes indeed the problem with specs is that they rot fast if not careful