README Convention

Definitions

1. The common expectation that a project’s top-level README should quickly explain what the project is, how to install it, how to use it, and where to go next. README conventions are part of the shared usability norms of open source repositories.

   In plain English: The usual expectations for what a project’s main README file should include.

   Example: "The library got more adoption once the README convention was respected and the setup example moved to the top."

Related Terms

• FOSS
• README
• Changelog
• Changelog Convention
• Community Edition
• Contributor Guide
• Contribution Guidelines
• Documentation Standard
• Project Docs