Data Bites: Writing better READMEs

Tuesday, January 17, 2023 at 1:00pm to 1:30pm

Virtual Event

Are you sharing research data or code? Make sure others can find and understand it! 

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.


This workshop is part of the "Data Bites" series of short online workshops; sign up for one or all! Other sessions in the series include: 

Data Bites: Writing better Data Availability Statements, Jan 17, 1:30pm-2:00pm

Data Bites: Backing up your stuff, Jan 19, 1:00-1:30pm

Data Bites: Finding a data repository, Jan 19, 1:30-2:00pm

Event Type


Events By Audience

MIT Community


MIT Libraries
Contact Email

Add to my calendar

Recent Activity

You're not going yet!

This event requires registration.