Begin docs

[ci skip]
This commit is contained in:
Mike Helmick 2013-06-06 13:41:56 -04:00
parent ec2bd7d686
commit 55641a1966
72 changed files with 26300 additions and 1 deletions

42
docs/usage/install.rst Normal file
View file

@ -0,0 +1,42 @@
.. _install:
Installation
============
Information on how to properly install Twython
Pip or Easy Install
-------------------
Install Twython via `pip <http://www.pip-installer.org/>`_::
$ pip install twython
or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::
$ easy_install twython
But, hey... `that's up to you <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.
Source Code
-----------
Twython is actively maintained on GitHub
Feel free to clone the repository::
git clone git://github.com/ryanmcgrath/twython.git
`tarball <https://github.com/ryanmcgrath/twython/tarball/master>`_::
$ curl -OL https://github.com/ryanmcgrath/twython/tarball/master
`zipball <https://github.com/ryanmcgrath/twython/tarball/master>`_::
$ curl -OL https://github.com/ryanmcgrath/twython/zipball/master
Now that you have the source code, install it into your site-packages directory::
$ python setup.py install