Code For Thought: The README
The last episode of Code For Thought in the ByteSized RSE season discusses README file. Peter Schmidt meets with Julian Lenz from the University of Swansea, who takes us through the importance of READMEs, what should go into them and at what stage should they be created.
Here are a few links you might find useful.
Example READMEs and templates
- https://github.com/matiassingers/awesome-readme a list of example READMEs
- https://dev.to/documatic/awesome-readme-examples-for-writing-better-readmes-3eh3 a guide for writing better READMEs
- https://github.com/matiassingers/awesome-readme#articles more articles on how to write READMEs
- https://github.com/othneildrew/Best-README-Template templates for READMEs
- https://github.com/Louis3797/awesome-readme-template another README template
- https://www.gnu.org/prep/standards/ GNU Coding standards. READMEs are mentioned in chapter 7.3
- https://medium.com/@NSomar/readme-md-history-and-components-a365aff07f10 a history of READMEs
- https://daringfireball.net/projects/markdown/ the MARKDOWN format
Byte-sized RSE is presented in collaboration with the UNIVERSE-HPC project. Find out more here.
Thank you for listening and for your ongoing support. It means the world to us!
You can also support our efforts by leaving a rating or review.
Follow or contact us on:
- Email mailto:firstname.lastname@example.org
- Patreon https://www.patreon.com/codeforthought
- Slack (ukrse.slack.com): @code4thought
- Mastadon: @email@example.com
- LinkedIn: https://www.linkedin.com/in/pweschmidt/
This podcast is licensed under the Creative Commons Licence.