Every assignment you submit you will include a ReadMe.md file.
The purpose of the ReadMe file is the same as the little paper insert you get in a new appliance -- to give the reader an introduction and overview of the product.
Your ReadMe file for the assignments must include:
-
The purpose of your program
-
List of files with one/or two-line summary
-
How to compile it (saying "use included Makefile" is ok)
-
Outline of data structure (depending on the assignment)
-
Outline of algorithm (depending on the assignment)
-
A list of people who materially helped you on the assignment. If you worked with a friend and you shared ideas, you need to list that person, e.g., "Josh Whedon helped me on this assignment". You do not need to list TAs, or professors, but you may feel free to do so.
The ReadMe file shows the reader, in a quick glance, what the program is about and gives a general idea of how it works. For short programs the readme file will be short, for more complicated programs the readme file will be longer.
Use outline form rather than long discursive paragraphs. A ReadMe file is an overview.
There is no correct readme format; within these guidelines, devise your own style.