The Setup and Reference sections

Overview

Teaching: 5 min
Exercises: 20 min
Questions
  • How to I provide setup instructions for researchers?

  • The Extras > Reference page is blank… how can I fix this?

Objectives
  • Complete the setup and reference sections of the lesson.

To provide setup instructions to researchers, just edit the setup.md page and add any content you want. I suggest including links to installation instructions for any software used.

Screenshot of the setup page

Follow the same instructions for editing the reference.md. This document should include links to any reference materials, tutorials, manuals, etc. It’s also a good place to highlight the most important commands and link to the most important tools.

Screenshot of the reference page

Key Points

  • To provide setup instructions, add content to the setup.md

  • To provide reference information, add content to the reference.md

  • You should always complete these sections for a lesson.