Fix warnings in documentation generation
[linpy.git] / doc / install.rst
index 545e773..d1b9f1f 100644 (file)
@@ -2,22 +2,43 @@
 
 Installation
 ------------
 
 Installation
 ------------
+Source
+======
+
+Users can install LinPy by cloning the git repository::
+
+    git clone https://scm.cri.ensmp.fr/git/linpy.git
+
+Then, execute the following to complete installation::
+    
+    python3 setup.py install
+
+PyPi
+====
+
+    sudo pip install linpy
 
 Dependencies
 ============
 
 
 Dependencies
 ============
 
-Pypol requires at least Python3.4. 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`_ .  
+LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu::
 
 
+    sudo apt-get install libislĀ­-dev
 
 
-Source
-======
+There are two optional dependencies that will maximize the use of LinPy's
+functions; SymPy and matplotlib. SymPy installation instructions can be found on the SymPy `download page`_. Matplotlib install information can be found at this `link`_.
 
 
-add link to pypi pypol documentation.
+License
+=======
 
 
-Git
-===
-
-add link to git repo
+LinPy is a free software, licensed under the `GPLv3 license`_ . 
 
 
 .. _here: http://freshmeat.net/projects/isl/
 
 
 .. _here: http://freshmeat.net/projects/isl/
+
+.. _download page: http://sympy.org/en/download.html
+
+.. _link: http://matplotlib.org/faq/installing_faq.html
+
+.. _GPLv3 license: https://www.gnu.org/licenses/gpl-3.0.txt
+