This is DIME Analytics template README.md. You should update the information in this README to reflect your project.
This is an excellent place to document what are the prerequisites to run this code and which files in this repository you should run your code from.
Here are examples of great READMEs that you can draw inspiration from. These READMES as all for public repositories (as we otherwise could not link to them), and private repository might not need as much details describing the project to the public. Instead, it is important that they link to project protocols and clearly documents how a new project member would start using the content in this repository.
- https://github.com/worldbank/KePSIE-MIS-Web - this README explains all the usages of this code in great detail
- https://github.com/worldbank/rio-safe-space - this README is shorter but links to pages with more detailed information
- https://github.com/worldbank/covid-mobile-data - this README links to more detailed installation guides, and instead focus on the indicator this code generates
- https://github.com/worldbank/ietoolkit - this README explains how to install the toolkit and describes how the public can contribute to this open source tool
- https://github.com/social-science-data-editors/template_README/blob/releases/README.md - this is a template README for replication packages
For a guide on how to format text in .md (markdown) files, see this getting started guide or this cheat sheet.
In addition to this template README, this repo is also created with a DIME Analytic's template .gitignore file. Read more about this template and why ignore files are needed here.