--- a +++ b/docs/installation.rst @@ -0,0 +1,51 @@ +.. highlight:: shell + +============ +Installation +============ + + +Stable release +-------------- + +To install wsic, run this command in your terminal: + +.. code-block:: console + + $ pip install wsic + +This is the preferred method to install wsic, as it will always install the most recent stable release. + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + + +From sources +------------ + +The sources for wsic can be downloaded from the `Github repo`_. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone git://github.com/john-p/wsic + +Or download the `tarball`_: + +.. code-block:: console + + $ curl -OJL https://github.com/john-p/wsic/tarball/master + +Once you have a copy of the source, you can install it with: + +.. code-block:: console + + $ python setup.py install + + +.. _Github repo: https://github.com/john-p/wsic +.. _tarball: https://github.com/john-p/wsic/tarball/master