Data

Data Bites - Creating README Files with Markdown

July 22, 2025, 12:30 pm to 1:00 pm

Date: Tuesday, July 22, 2025
Time: 12:30pm - 1:00pm
Presenter: Eugene Barsky, Andrew Li
Location: Online

Workshop: Creating README Files with Markdown

This hands-on workshop, delivered by the UBC Library Research Data Management team, focuses on how to use Markdown to create clear, professional README files for research projects. Designed for graduate students, researchers, and staff, the session highlights how Markdown simplifies documentation and improves the accessibility and longevity of research data.

Participants will learn how to:

  • Apply Markdown syntax to structure and format effective README files
  • Include essential elements such as project descriptions, file overviews, and usage instructions
  • Use Markdown-based README files to enhance research transparency, reproducibility, and data sharing

 

Location: ONLINE

(A Zoom link will be sent to registrants 3 hours before the event starts.)

Campus/Source
UBC Library–Vancouver

https://libcal.library.ubc.ca/event/3900597

  • Data
  • Digital Scholarship
  • Research Commons
  • Research Data Management

First Nations land acknowledegement

We acknowledge that UBC's two main campuses are located on the traditional, ancestral and unceded territories of the xwmə0– kwəyˇəm (Musqueam) and Syilx (Okanagan) peoples, and that UBC’s activities take place on Indigenous lands throughout British Columbia and beyond.

Research Data Management @ UBC

UBC Vancouver & UBC Okanagan
UBC Library | Office of the Chief Information Officer | Vice-President, Research and Innovation,
Website rdm.ubc.ca

UBC receives support for managing its research enterprise from the federal Research Support Fund.

UBC Crest The official logo of the University of British Columbia. Urgent Message An exclamation mark in a speech bubble. Caret An arrowhead indicating direction. Arrow An arrow indicating direction. Arrow in Circle An arrow indicating direction. Arrow in Circle An arrow indicating direction. Bluesky The logo for the Bluesky social media service. Chats Two speech clouds. Facebook The logo for the Facebook social media service. Information The letter 'i' in a circle. Instagram The logo for the Instagram social media service. External Link An arrow entering a square. Linkedin The logo for the LinkedIn social media service. Location Pin A map location pin. Mail An envelope. Menu Three horizontal lines indicating a menu. Minus A minus sign. Telephone An antique telephone. Plus A plus symbol indicating more or the ability to add. Search A magnifying glass. Twitter The logo for the Twitter social media service. Youtube The logo for the YouTube video sharing service.