Skip to content

Don't use an LLM for your README.md

til.andrew-quinn.me
7 pointshiAndrewQuinn6 comments
On HN

Comments

1000% agree. I would say AI generated readme is full soup of information but doesn't bring much value to what's intended. Readme should introduce the project value, the authors taste and how to use it. Too much info, no body will read, well ai agent may read them tho.

The natural landing point for info you'd want an agent acting on a user's behalf but don't want to drag the user themselves through is probably just an AGENTS.md file or something I would think

A signal only carries information if it is expensive to fake. The male peacock’s mesmerizing tail of evil eyes works precisely because a sickly peacock cannot grow one.

This is by far the most important insight in this write-up and I will be thinking about it for days to come.

Much obliged. I like using footnotes to get more unhinged than the actual post, I think simonw reblogged one of my footnotes a few months back which was just a personal note and that was killer.

No, please do. Makes it easier to see at a glance if it's worth my attention or not.

“Don’t use an LLM for the task” is generally advisable.

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.