The README File

At the top level within your work directory, you must create a README file, which must be viewable as plain text. This file must contain the following things:

1. A high-level roadmap of the code. What does each file do? If you've split your project up into subdirectories, what does each subdirectory do?
2. A list of the parts of the project that you attempted.
3. Any known bugs. If, for example, you tried a specific part of the project, and it works except in some really weird cases, tell me about the exceptions.