Writing better READMEs: mini workshop

Wednesday, January 12, 2022 at 11:00am to 11:30am

Virtual Event

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.

Register: https://libcal.mit.edu/calendar/events/readmes_iap2022

Event Type


Events By Interest

Academic, Career Development, IAP (Independent Activities Period)

Events By Audience

MIT Community



MIT Libraries


Contact Email


Add to my calendar

Recent Activity

You're not going yet!

This event requires registration.