Skip to main content
MIT Mobile homeEvents - old home
Event Detail

Data Bites: Writing Better READMEs

Wed Apr 17, 2024 3:30–4:00 PM

Description

README files are standard for software, but they provide useful basic documentation for datasets as well. Get up to speed on efficiently writing useful README files for datasets and software in this short class. We'll cover some common things you should include in these files, as well as how to provide a citation to ensure you get credit for your hard work, and will share links to resources. Save yourself time and trouble -- if you are sharing data or software, you need READMEs! This workshop will be over Zoom and the link will be emailed to participants.
  • Data Bites: Writing Better READMEs
    README files are standard for software, but they provide useful basic documentation for datasets as well. Get up to speed on efficiently writing useful README files for datasets and software in this short class. We'll cover some common things you should include in these files, as well as how to provide a citation to ensure you get credit for your hard work, and will share links to resources. Save yourself time and trouble -- if you are sharing data or software, you need READMEs! This workshop will be over Zoom and the link will be emailed to participants.