One recommendation: do not let the LLM write your README for you. It can write other docs (though IME they still suck at it), but your README needs to be focused and easily digestible by a human glancing at the project.

LLMs have no concept of focus when it comes to docs, so they spew out way more information than is necessary or helpful to a human reading the document.

▲

rickkjp 3 hours ago | parent [-]

Ha - ok understood, although in my specific case I think this is better than anything I would have written. I edited it pretty hard to get it to say what I wanted it to say, so not sure if that counts. Thanks anyway for the feedback.

	▲	hankbond 2 hours ago \| parent [-]
		This is one of the cases where I think people really want a personal touch. Your README is the "hook" of a project, it's the first thing we see, and so you want to advertise "this thing was made with thought and care". Also the README does not need to be exhaustive, it should be a form of advertising and you can nest the lower level documentation in a /docs and link the sections from the README.