rsukkerd/Parallel-Bug-Fixes — Issue #10: Add a README.md file to repository
Author: bestchai
Created: 2012-01-20 20:48:44+00:00
State: open

GitHub parses the README.md file at the top of the repository and displays it on the project github page. For example, here is a project that has a README.md, which is displayed at the bottom of the page:
https://github.com/github/markup

For this file to be parsed correctly by github it must use appropriate markup. For example, the source for the README.md above is here:
https://raw.github.com/github/markup/master/README.md

We can use the README.md file for the following:
1. Explain the purpose of the project.
2. Explain how to run the various programs that are part of the project -- explain arguments, etc.