Skip to content

Instantly share code, notes, and snippets.

@carlcarl
Created April 11, 2016 05:29
Show Gist options
  • Select an option

  • Save carlcarl/8561c87938e1fa758849ca6e4f23cc5a to your computer and use it in GitHub Desktop.

Select an option

Save carlcarl/8561c87938e1fa758849ca6e4f23cc5a to your computer and use it in GitHub Desktop.
README template

$project

$project will solve your problem of where to start with documentation, by providing a basic explanation of how to do it easily.

Look how easy it is to use:

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

Features

  • Be awesome
  • Make things faster

Installation

Install $project by running:

install project

Contribute

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

Support

If you are having issues, please let us know. We have a mailing list located at: [email protected]

License

The project is licensed under the BSD license.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment