.. highlight:: shell

============
Installation
============


Stable release
--------------

To install xedocs, run this command in your terminal:

.. code-block:: console

    $ pip install xedocs

This is the preferred method to install xedocs, 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 source
-----------

The source for xedocs can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/jmosbacher/xedocs

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/jmosbacher/xedocs/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ pip install .

.. _Github repo: https://github.com/jmosbacher/xedocs
.. _tarball: https://github.com/jmosbacher/xedocs/tarball/master