[EN] ByteSized RSE: The README - with Julian Lenz

0 Views· 06/07/23
Code for Thought
Code for Thought
0 Subscribers
0

And in this last episode of our first ByteSized RSE season, we talk about the README file. My guest in this episode is Julian Lenz from the University in Swansea, UK who will take us through the importance of READMEs, what should go into them and at what stage should you create one (spoiler alert: a.s.a.p.). <br/><br/>Here are a few links you might find useful.<br/>Example READMEs and templateshttps://github.com/matiassingers/awesome-readme a list of example READMEshttps://dev.to/documatic/aweso....me-readme-examples-f a guide for writing better READMEshttps://github.com/matiassingers/awesome-readme#articles more articles on how to write READMEshttps://github.com/othneildrew..../Best-README-Templat templates for READMEshttps://github.com/Louis3797/a....wesome-readme-templa another README templateBackground https://www.gnu.org/prep/standards/ GNU Coding standards. READMEs are mentioned in chapter 7.3https://medium.com/@NSomar/rea....dme-md-history-and-c a history of READMEshttps://daringfireball.net/projects/markdown/ the MARKDOWN formatByte-sized RSE is presented in collaboration with the UNIVERSE-HPC project.<br/>https://www.imperial.ac.uk/computational-methods/rse/events/byte-sized-rse/<br/>ByteSized RSE link to Imperial CollegeSupport the showThank you for listening and your ongoing support. It means the world to us! <br/>You can also support our efforts by leaving a rating or review.<br/>Follow or contact us on Email mailto:code4thought@proton.me Patreon https://www.patreon.com/codeforthought Slack (ukrse.slack.com): @code4thought Mastadon: @code4thought@fosstodon.org LinkedIn: https://www.linkedin.com/in/pweschmidt/ This podcast is licensed under the Creative Commons Licence: https://creativecommons.org/licenses/by-sa/4.0/<br/><br/>

Show more

 0 Comments sort   Sort By


Up next