From: Vivien Maisonneuve Date: Wed, 20 Aug 2014 08:19:30 +0000 (+0200) Subject: Reformat examples/README.rst X-Git-Tag: 1.0~15 X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/commitdiff_plain/5578ef7493bf0ac9c44a6632108975d26583217c?ds=inline Reformat examples/README.rst --- diff --git a/examples/README.rst b/examples/README.rst index 17ee50f..da5278a 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -1,17 +1,22 @@ -======== Examples ======== This directory contains LinPy examples programs. + Running Examples -================ +---------------- -To run the individual examples one needs to have Python version ≥ 3.4 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:: +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@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 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. +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.