Skip to Main Content

Data bites: Writing better READMEs

Event box

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 30 minute workshop is a part of a short series of workshops, “Data Bites”, on essential data management topics. Attend one or multiple topic sessions. This workshop will be over Zoom and the link will be emailed to participants.

Date:
Friday, October 16, 2026
Time:
12:30pm - 1:00pm
Categories:
Classes & workshops  

Registration is required. There are 47 seats available.

Event Organizer

Profile photo of Phoebe Ayers
Phoebe Ayers

Librarian for EECS, IDSS, and Math

Research Data Management Services

contact me