aboutsummaryrefslogtreecommitdiff
path: root/doc/installation.rst
diff options
context:
space:
mode:
authorSander Vrijders <sander.vrijders@ugent.be>2018-03-26 16:25:14 +0200
committerSander Vrijders <sander.vrijders@ugent.be>2018-03-28 16:41:40 +0200
commita1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157 (patch)
tree65172a461889ca93053187494a565423a54f112e /doc/installation.rst
parenta95c3b376053ed00f0e7184dbd228598a9aaf50f (diff)
downloadrumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.tar.gz
rumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.zip
rumba: Add Rumba documentation website
This adds a documentation website for Rumba which is triggered automatically after changes to master.
Diffstat (limited to 'doc/installation.rst')
-rw-r--r--doc/installation.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644
index 0000000..c2038d0
--- /dev/null
+++ b/doc/installation.rst
@@ -0,0 +1,21 @@
+Installation
+************************
+
+The easiest way to install Rumba is through pip. Rumba can be found on
+the `PyPi <https://pypi.python.org/pypi/Rumba>`_ and can thus be
+installed through pip. ::
+
+ $ pip install rumba
+
+Rumba supports both Python 2 and 3.
+
+For Debian and Ubuntu, the following command will ensure that the
+required dependencies are installed (replace python-dev with
+python3-dev if using Python 3): ::
+
+ $ apt-get install build-essential libssl-dev libffi-dev python-dev
+
+To install the latest version from source, clone the repository and
+install it from the command line: ::
+
+ $ python setup.py install