Rename example squares.py into tutorial.py
[linpy.git] / examples / README.rst
index 9c76280..da5278a 100644 (file)
@@ -1,17 +1,22 @@
 
-========
 Examples
 ========
 
-This directory contains pypol examples programs.
+This directory contains LinPy examples programs.
+
 
 Running Examples
-================
+----------------
 
-To run the individual examples one needs to have Python version ≥ 3.4 installed and pypol must be in your ``PYTHONPATH`` environment variable.
-Most examples can be run from the command line ``python3`` and the name of the example::
+To run the individual examples one needs to have Python version 3.4 or above
+installed and LinPy must be in your ``PYTHONPATH`` environment variable. Most
+examples can be run from the command line ``python3`` and the name of the
+example::
 
-    vivien@bardo:~/pypol/examples$ export PYTHONPATH=$PWD/..:$PYTHONPATH
-    vivien@bardo:~/pypol/examples$ python3 squares.py
+    vivien@rochefort:~/linpy/examples$ export PYTHONPATH=$PWD/..:$PYTHONPATH
+    vivien@rochefort:~/linpy/examples$ python3 squares.py
 
-Note: on most systems, the current directory is searched by Python automatically, so ``python3 examples/squares.py`` works from the pypol root directory, however there are systems (Ubuntu Intrepid) where this doesn't work by default, unless you put ``PYTHONPATH=.`` into your .bashrc for example.
+Note: on most systems, the current directory is searched by Python
+automatically, so ``python3 examples/squares.py`` works from the LinPy root
+directory, however there are systems (Ubuntu Intrepid) where this doesn't work
+by default, unless you put ``PYTHONPATH=.`` into your .bashrc for example.