Readme

[sgrieve]

We need to write up a readme for the project. As a minimum it should contain:

• [x] Project overview
• [x] What problem it solves
• [x] Contribution guidelines
• [x] Install guide
• [x] Usage examples

From the talk today, our readme should cover:

§ Value of work should be clear – or lose marks!
§ Context - building on existing work, starting something new?
§ What does your software/scripts do?
§ How does it benefit others, and who?
§ What’s novel about your work?
§ Future potential – interesting ideas for future steps

[r-j-arnold]

Stuart probably best to do this as the most aware of the academic context

[sgrieve]

working on it now!

[sgrieve]

Readme finished!