Slide 12
Slide 12 text
THE IMPORTANCE OF THE README
Of course you need the basics: installation, running the code, running the tests.
Beyond that the README is your chance to explain your work – a quick guide to
the classes, why you made certain choices, and perhaps areas to improve.
The best gems all have a high quality README. Your test should too.
It can also be a place to keep track of your progress as you go through the test. Start with
your TODO list in the README, and move items out of it as you do them. What’s left at the
end becomes the list of areas for improvement – things you would have done in a real
project or if you had more time.