[yorick-ygsl] 06/10: Update doc.

[Thibaut Jean-Claude Paumard]

This is an automated email from the git hooks/post-receive script.

thibaut pushed a commit to branch upstream
in repository yorick-ygsl.

commit 324fe70de868efbdd0018deb7645598ca4ed560f
Author: Éric Thiébaut <eric.thiebaut at univ-lyon1.fr>
Date:   Fri Mar 18 08:39:11 2016 +0100

    Update doc.
---
 README.md | 73 ++++++++++++++++++++++++++++++++++-----------------------------
 1 file changed, 40 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 9df021e..74237e6 100644
--- a/README.md
+++ b/README.md
@@ -9,64 +9,71 @@ Installation
 ------------
 
 In short, building and installing the plug-in can be as quick as:
-````
-$ cd $BUILD_DIR
-$ $SRC_DIR/configure
-$ make
-$ make install
+````{.sh}
+cd $BUILD_DIR
+$SRC_DIR/configure
+make
+make install
 ````
 where `$BUILD_DIR` is the build directory (at your convenience) and
-`$SRC\_DIR` is the source directory of the plug-in code.  The build and
+`$SRC_DIR` is the source directory of the plug-in code.  The build and
 source directories can be the same in which case, call `./configure` to
 configure for building.
 
-Then, to use the plug-in in Yorick:
+If the plug-in has been properly installed, it is sufficient to use any
+function of YFITSIO to automatically load the plug-in.  You may force the
+loading of the plug-in by something like:
+````{.sh}
+#include "gsl.i"
 ````
-$ yorick
-> include "gsl.i"
+or
+````{.sh}
+require, "gsl.i";
 ````
-More detailled explanations are given below.
+in your code.
+
+More detailled installation explanations are given below.
 
 1. You must have Yorick and the GSL (GNU Scientific Library) installed
    on your machine.  (See the *"Links"* section below.)
 
 2. Unpack the plug-in code somewhere.
 
-3. Configure for compilation.  The are two possibilities:
+3. Configure for compilation.  There are two possibilities:
 
-   For an **in-place build**, go to the source directory of the plug-in
-   code and run the configuration script:
-   ````
-   $ cd SRC_DIR
-   $ ./configure
+   For an **in-place build**, go to the source directory, say `$SRC_DIR`, of
+   the plug-in code and run the configuration script:
+   ````{.sh}
+   cd $SRC_DIR
+   ./configure
    ````
    To see the configuration options, call:
+   ````{.sh}
+   ./configure --help
    ````
-   $ ./configure --help
-   ````
-   
-   To compile in a **different build directory**, say BUILD_DIR, create the
-   build directory, go to the build directory, and run the configuration
+
+   To compile in a **different build directory**, say `$BUILD_DIR`, create the
+   build directory, go to the build directory and run the configuration
    script:
+   ````{.sh}
+   mkdir -p $BUILD_DIR
+   cd $BUILD_DIR
+   $SRC_DIR/configure
    ````
-   $ mkdir -p $BUILD_DIR
-   $ cd $BUILD_DIR
-   $ $SRC_DIR/configure
-   ````
-   where `$SRC_DIR` is the path to the source directory of the plug-in
-   code. To see the configuration options, call:
-   ````
-   $ $SRC_DIR/configure --help
+   where `$SRC_DIR` is the path to the source directory of the plug-in code.
+   To see the configuration options, call:
+   ````{.sh}
+   $SRC_DIR/configure --help
    ````
 
 4. Compile the code:
-   ````
-   $ make
+   ````{.sh}
+   make
    ````
 
 4. Install the plug-in in Yorick directories:
-   ````
-   $ make install
+   ````{.sh}
+   make install
    ````
 
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/yorick-ygsl.git