diff options
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..ea0bfae --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,38 @@ +.. _install: + +============ +Installation +============ + +Getting started is pretty simple. The first step is to install the library. + +Pip Install +=========== + +The easiest way to get terminaltables is to use `pip <https://pip.pypa.io>`_. Simply run this command. + +.. code-block:: bash + + pip install terminaltables + +Latest from GitHub +================== + +You can also elect to install the latest bleeding-edge version by using pip to install directly from the GitHub +repository. + +.. code-block:: bash + + pip install git+https://github.com/Robpol86/terminaltables.git + +Clone and Install +================= + +Lastly you can also just clone the repo and install from it. Usually you only need to do this if you plan on +`contributing <https://github.com/Robpol86/terminaltables/blob/master/CONTRIBUTING.md>`_ to the project. + +.. code-block:: bash + + git clone https://github.com/Robpol86/terminaltables.git + cd terminaltables + python setup.py install |