Writing a README

Remember the last time when someone else handed over their project for you to continue and that everything makes sense? Me neither. Sometimes, I even scratch my head trying to decipher my own files. This is where documentation comes in handy and every little bit can help. With a filename in all caps, a README grabs your attention and helps future-you (and everyone else) understand your project at a glance. This 30 minute webinar goes over the basic elements of a README and you can start writing one in 5 minutes.

If you need assistance to fully participate in this workshop, or have an accessibility request, please contact the instructor in advance (zhai@iastate.edu).