Re:The AGENTS.md Standard: A simple, open format for guiding...
by ameliaquining on Tuesday August 19, 2025 @09:17PM
(#44957805)
README often contains only basic context for the project and instructions for basic tasks like running it and building it from source. If additional information for developers, like coding conventions, is short enough compared to the rest of the README then it sometimes gets added there too, but if there's a lot of it then it's frequently kept elsewhere to prevent README from getting overwhelming for end users and random people just checking out the project.
[ Parent
| on HN ]
Re:The AGENTS.md Standard: A simple, open format for guiding...
by blinkymach12 on Tuesday August 19, 2025 @09:31PM
(#44957876)
I don't think anything requires a README.md to be monolithic. They often provide the introductory material that you mention here, then link out to other appropriate files for contribution guidelines, etc.