4 ms·
We're in an era where the documentation is written to be read by LLM's, and I fully expect the README files to follow suit.
by Thanemate 4mo ago
We're in an era where the documentation is written to be read by LLM's, and I fully expect the README files to follow suit.
- hootz 4mo agoREADME should be written for humans. Agents don't need fancy rendering in the repository page, we do. Agents already have their own dedicated context file.
- dgrin91 4mo agoIsn't this the whole point of an AGENTS.md file? So that you can leave the readme for humans and put LLM-friendly crap in a separate file?
- rvz 4mo agoIf I see an excessively long README which is competing to being as long as War and Peace, I am immediately not going to read it. This is just yet another low-effort slop specimen.
- serious_angel 4mo agoNonsense. Apologies, but please consider the infinitely magnificent world out there... and not your own echo-chambered desaturated imagination. I've been a travelling developer at military for security services for more than two decades now, and there's not a single soul out there I know in person who would expect or claim that any documentation is not for people but machines exclusively or initially even. A documentation, whether formatted/standardized/conventional or not, is for a human, and always will be, because this is what you leave in the history of your own work of life. > You can add a README file to your repository to tell other __people__ why your project is useful, what they can do with your project, and how they can use it. > > Source: https://github.com/github/docs/blob/9af628699ba0d381fb04929a6384c70d63cef8b9/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md