BotZ/docs/installation.rst
2019-01-07 11:16:16 +01:00

52 lines
1.1 KiB
ReStructuredText

.. highlight:: shell
============
Installation
============
Stable release
--------------
To install Bot_Z, run this command in your terminal:
.. code-block:: console
$ pip install bot_z
This is the preferred method to install Bot_Z, 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 Bot_Z can be downloaded from the `Github repo`_.
You can either clone the public repository:
.. code-block:: console
$ git clone git://github.com/lbarcaroli/bot_z
Or download the `tarball`_:
.. code-block:: console
$ curl -OL https://github.com/lbarcaroli/bot_z/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/lbarcaroli/bot_z
.. _tarball: https://github.com/lbarcaroli/bot_z/tarball/master