Skip to content

Instantly share code, notes, and snippets.

@estcla
estcla / README.md
Created June 19, 2016 21:14
README: Notes and Guidelines

Writing a README

Providing a README is generally considered to be best practice when writing software, and is one of the few things that separates us from animals. Please follow the guidelines below when constructing your README, and have it submitted before the final class on July 14th.

README Minimum Requirements if Presenting

  1. A brief introduction at the beginning that explains what the project is, with at least one screenshot of the final app.
  2. A license section at the end (such as MIT or Apache).
  3. Use of the Markdown file format.

README Minimum Requirements if Submitting

In addition to the requirements listed above, you'll also need to include the following things if you choose not to present: