Menu
Sign In Search Podcasts Charts People & Topics Add Podcast API Pricing
Podcast Image

Code for Thought

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

07 Jun 2023

Description

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.). Here are a few links you might find useful.Example READMEs and templateshttps://github.com/matiassingers/awesome-readme a list of example READMEshttps://dev.to/documatic/awesome-readme-examples-for-writing-better-readmes-3eh3 a guide for writing better READMEshttps://github.com/matiassingers/awesome-readme#articles more articles on how to write READMEshttps://github.com/othneildrew/Best-README-Template templates for READMEshttps://github.com/Louis3797/awesome-readme-template another README templateBackground https://www.gnu.org/prep/standards/ GNU Coding standards. READMEs are mentioned in chapter 7.3https://medium.com/@NSomar/readme-md-history-and-components-a365aff07f10 a history of READMEshttps://daringfireball.net/projects/markdown/ the MARKDOWN formatByte-sized RSE is presented in collaboration with the UNIVERSE-HPC project.https://www.imperial.ac.uk/computational-methods/rse/events/byte-sized-rse/ByteSized RSE link to Imperial CollegeGet in touchThank you for listening! Merci de votre écoute! Vielen Dank für´s Zuhören! Contact Details/ Coordonnées / Kontakt: Email mailto:[email protected] UK RSE Slack (ukrse.slack.com): @code4thought or @piddie Bluesky: https://bsky.app/profile/code4thought.bsky.social LinkedIn: https://www.linkedin.com/in/pweschmidt/ (personal Profile)LinkedIn: https://www.linkedin.com/company/codeforthought/ (Code for Thought Profile) This podcast is licensed under the Creative Commons Licence: https://creativecommons.org/licenses/by-sa/4.0/

Audio
Featured in this Episode

No persons identified in this episode.

Transcription

This episode hasn't been transcribed yet

Help us prioritize this episode for transcription by upvoting it.

0 upvotes
🗳️ Sign in to Upvote

Popular episodes get transcribed faster

Comments

There are no comments yet.

Please log in to write the first comment.