README Template

Below is a template provided for use when building your README file for students.

Project Title

Project description goes here.

Getting Started

Instructions for how to get a copy of the project running on your local machine.


Examples here


Step by step explanation of how to get a dev environment running.

List out the steps

Give an example here


Explain the steps needed to run any automated tests

Break Down Tests

Explain what each test does and why

Examples here

Project Instructions

This section should contain all the student deliverables for this project.

Built With

  • Item1 – Description of item
  • Item2 – Description of item
  • Item3 – Description of item

Include all items used to build project.



View Github