Add license to examples
[linpy.git] / doc / install.rst
index a19f9ba..d1b9f1f 100644 (file)
@@ -2,28 +2,43 @@
 
 Installation
 ------------
-
 Source
 ======
 
-Users can install Linpy by cloning the git repository::
+Users can install LinPy by cloning the git repository::
 
-       git clone https://scm.cri.ensmp.fr/git/pypol.git
+    git clone https://scm.cri.ensmp.fr/git/linpy.git
 
-Install
-=======
+Then, execute the following to complete installation::
+    
+    python3 setup.py install
+
+PyPi
+====
 
-…execute `setup.py` 
+    sudo pip install linpy
 
 Dependencies
 ============
 
-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`_ .  
+LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu::
 
-To use the Linpy plotting function, users need to install matplotlib using instructions in the following `link`_.
+    sudo apt-get install libisl­-dev
 
+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`_.
+
+License
+=======
+
+LinPy is a free software, licensed under the `GPLv3 license`_ . 
 
 
 .. _here: http://freshmeat.net/projects/isl/
 
-.. _link: http://matplotlib.org/faq/installing_faq.html
\ No newline at end of file
+.. _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
+