README Files

Video

Slides

Slides

Exercise

Edit your README file. Take your time. This is important!

Make sure to include the following information:

  • What does your project do?

  • How does the user access your project? (E.g. download, or clone with git clone…)

  • How does the user call the main script(s) that should be executed?

  • And perhaps any other elements you are inspired to add (check out the examples!)

NB: We will have another chance to take a look at dependencies and prerequisites, but if you have opportunity to add these here: please do!