==========================================
Python Documentation and Releasing Project
==========================================

Project Description:
--------------------

The purpose of this project is to test the functioning of git, GitHub, ReadTheDocs and releasing of a Python package.

:Authors: Hoang Long Nguyen
:Email: hn269@cornell.edu

Links:
------

ReadTheDocs: https://readthedocs.org/projects/dummy/

Quickstart:
-----------

+ At the root document, run ``python setup.py install``.
+ Test the module with ``python setup.py test``.
+ Calling module:
	- ``import dummy``
	- ``result1 = dummy.add(n1,n2)``
	- ``result2 = dummy.sub(n1,n2)``

Dependencies:
-------------

jinja 2.7.2 for documentation
Recommended numpy.

