The Johns Hopkins University Open Source Programs Office (OSPO) is happy to announce the next in our Explainer series, a collection of bite-sized videos tackling a variety of open-source essentials.
This explainer video shows you how to write a great README for your open source repository. A README serves as an introduction to your code, providing users with important information on installment how to get started. The Explainer outlines what information to include in your README, including how to identify your project, how to help users evaluate it, and how to help users use and engage with it. The Explainer also includes tips for managing READMEs for projects with multiple repositories and keeping your README up-to-date.
Look out later this summer for Explainers about Citing Research Software and Open Source Project Governance.
Have an idea for an Explainer? We’d love to hear it! Please reach out to ospo@jhu.edu.
View the complete OSPO Explainer Library at https://ospo.library.jhu.edu/ospo-explainers.