An outline in GitHub Markdown of a proper and complete README file example for a software project. View RAW to see Markdown.

example_README.md

project name

(project name) will solve your problem of _____ by providing _____ and allowing _____.

Look how easy it is to use (code example follows):

import project
# get your stuff done
project.do_stuff()

Features

• Be awesome
• Make things faster

Installation

Install (project name) by running:

install project

Contribute

• Issue Tracker: https://github.com/$project/$project/issues
• Source Code: https://github.com/$project/$project

Support

If you are having issues, please let us know.

We have a mailing list located at: project@google-groups.com

License

The project is licensed under the BSD license.

This README is based on an example found here. ← This is a real link.