X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/7b93cea1daf2889e9ee10ca9c22a1b5124404937..b02f9551644488e5943f968ac847fe4ed7690d6b:/doc/install.rst
diff --git a/doc/install.rst b/doc/install.rst
index 0ed0654..3a56000 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -1,29 +1,47 @@
-.. _installation:
Installation
+============
+
+Dependencies
------------
-Source
-======
+LinPy requires Python version 3.4 or above to work.
-Users can install LinPy by cloning the git repository::
+LinPy's one mandatory dependency is isl version 0.12 or 0.13 (it may work with other versions of isl, but this has not been tested).
+isl can be downloaded `here `_ or preferably, using your favorite distribution's package manager.
+For Ubuntu, the command to run is::
- git clone https://scm.cri.ensmp.fr/git/pypol.git
+ sudo apt-get install libisl-dev
-Install
-=======
+For Arch Linux, run::
-â¦execute `setup.py`
+ sudo pacman -S isl
-Dependencies
-============
+Apart from isl, there are two optional dependencies that will maximize the use of LinPy's functions: `SymPy `_ and `matplotlib `_.
+Please consult the `SymPy download page `_ and `matplotlib installation instructions `_ to install these libraries.
-LinPy has several dependencies. Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both are available `here`_ .
+pip
+---
-To use the LinPy plotting function, users need to install matplotlib using instructions in the following `link`_.
+.. warning::
+
+ The project has not been published in PyPI yet, so this section is not relevant.
+ Instead, see the :ref:`source` section to install LinPy.
+
+LinPy can be installed using pip with the command::
+
+ sudo pip install linpy
+
+.. _source:
+
+Source
+------
+Alternatively, LinPy can be installed from the source.
+First, clone the public git repository::
+ git clone https://scm.cri.ensmp.fr/git/linpy.git
-.. _here: http://freshmeat.net/projects/isl/
+and build and install as usual with::
-.. _link: http://matplotlib.org/faq/installing_faq.html
+ sudo python3 setup.py install