I am now starting to write a Readme for that project with the following goals in mind
Anybody new to the project should get an understanding of
- the overall scope of the project
- what technology was used in the project
Any potential employer looking at the Readme would understand what problems I solved with this project and hopefully would be impressed.
How good a job does this Readme do?
And how can I improve it?