Reformat examples/README.rst
[linpy.git] / examples / README.rst
1
2 Examples
3 ========
4
5 This directory contains LinPy examples programs.
6
7
8 Running Examples
9 ----------------
10
11 To run the individual examples one needs to have Python version 3.4 or above
12 installed and LinPy must be in your ``PYTHONPATH`` environment variable. Most
13 examples can be run from the command line ``python3`` and the name of the
14 example::
15
16 vivien@rochefort:~/linpy/examples$ export PYTHONPATH=$PWD/..:$PYTHONPATH
17 vivien@rochefort:~/linpy/examples$ python3 squares.py
18
19 Note: on most systems, the current directory is searched by Python
20 automatically, so ``python3 examples/squares.py`` works from the LinPy root
21 directory, however there are systems (Ubuntu Intrepid) where this doesn't work
22 by default, unless you put ``PYTHONPATH=.`` into your .bashrc for example.