templatereadme.org
templatereadme.org is an online editor to help authors make README documents for their replication.
Link to production site: templatereadme.org
Features
- Choose from list of sections to add to your readme
- Edit the contents of each section
- Drag and drop to rearrange sections
- Download your README file
Feedback
Feedback is appreciated! Reach out on Twitter or submit a new issue!
License
MIT
This site is based on readme.so (Peterson 2021) with small modifications by Miklós Koren. The content is adapted from the Social Science Template README (Vilhuber et al. 2020).
References
- Peterson, Katherine. (2021). "readme.so" GitHub https://github.com/octokatherine/readme.so (commit
af0e1e
) Accessed on 2021-11-25.
- Vilhuber, Lars, Connolly, Marie, Koren, Miklós, Llull, Joan, & Morrow, Peter. (2020). "A template README for social science replication packages" (v1.0.0). Zenodo.
![](https://zenodo.org/badge/DOI/10.5281/zenodo.4319999.svg)