setup.py: README

Date: January 26th 2016
Last updated: January 26th 2016

The README file varies greatly across pytools. You can search for examples here. The following template is one that I will find useful in the future.

===========
Title
===========

A short description of the package. Describe briefly <x> and also <y>. 


Installation
=========


Linux
----------
    #!/usr/bin/env python
    pip install package

Mac
----------
    # install notes

windows
----------
    # install notes


Usage
=========

    from package import module as m

    var = m()
    m.method1()


Contributors
=========
List contributors
+
+
+


License
=========

results matching ""

    No results matching ""