Readme

• An old traditional file name
• Generally it was what it sounds like
• What the developer would like you to read
• Filenames can be README, readme, readme.first, readme.md
• We use readme.md, which is markdown formatted
• Below are the minimal content requirements
• You can of course have more in your readme

Contents

• Minimal required contents. Specific assignment may ask for more
• Key facts
  1. Project name, and your names (in the case of a team project)
  2. Last edit date
  3. How to build and/or run
  4. Relevant other urls, e.g. heroku
• Description and explanations
  1. Key algorithms
  2. Key data structures
  3. Key libraries used
  4. Key issues
• Change History for each major change committed
  1. Title and date
  2. Brief Description
  3. Main contributor (student name)