Quelques notes permettant de demarrer avec Melina++

                       ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~

INSTALLATION (sur un systeme UNIX ou equivalent)
------------
1. Recopier l'archive melina++2009-05-11-0_1_Beta.tgz sous /tmp (par exemple,
   sinon, remplacer /tmp par le repertoire idoine dans la suite).

2. Pour une installation "chez soi", taper par exemple :
    cd ; mkdir melina++ ; cd melina++

3. Decompresser l'archive :
    tar zxf /tmp/melina++2009-05-11-0_1_Beta.tgz
   ou bien
    gunzip /tmp/melina++2009-05-11-0_1_Beta.tgz
    tar xf /tmp/melina++2009-05-11-0_1_Beta.tar

4. Reperer le shell utilise en tapant :
    echo $SHELL

   Si le shell est csh ou tcsh, alors taper :
    set path = ($cwd/bin $path .)

   Si le shell est sh ou bash, alors taper :
    PATH=$PWD/bin:$PATH:.
    export PATH

5. Pour poursuivre l'installation, taper les commandes suivantes (ces instructions
   figurent dans le fichier ./READMEs/README.txt) :

    pwd
     -> ceci pour reperer le nom absolu du repertoire d'installation
    cd bin
    m+path
     -> ici, copier-coller la reponse a la commande pwd precedente (avec le / du debut)
    m+install
    m+compilall

Remarques.
1. L'installation peut echouer en affichant des messages abscons si le systeme ne possede
   pas la configuration attendue. C'est notamment le cas si le C-shell (/bin/csh) n'est pas
   installe ou si le compilateur n'est pas trouve.

2. Pour une installation au niveau du systeme, sous /usr/local par exemple,
   la procedure est analogue, mais il faut des droits administrateur.

3. Ne pas deplacer la bibliotheque une fois installee. Si cela s'avere necessaire,
   il faut relancer les trois commandes m+path, m+install et m+compilall.


PROGRAMMATION
-------------
Dans le repertoire ou se situent les fichiers relatifs au probleme a traiter,
seul un fichier doit contenir la fonction main. Il faut referencer MELINA.h++
uniquement dans ce fichier. Un tel fichier type ressemble a :

- - - - - - - - - - - - - - - - - - - - - - - - - 
using namespace std;
#include "MELINA.h++"

int main()
{
        init();   // A ne pas oublier !
        logon();  // Facultatif : utile en phase de mise au point pour suivre le
                  // deroulement de l'execution. A desactiver en temps normal car
                  // cela cree un fichier log souvent volumineux.

// Debut de votre programme
        ...

}
- - - - - - - - - - - - - - - - - - - - - - - - - 


Dans les autres fichiers, il faut referencer, si besoin, directement les fichiers .h
specifiques, par exemple :

#include "TermMatrix.h"
#include "TermVector.h"


UTILISATION
-----------
* Preliminaire
Tout d'abord, il faut que la variable d'environnement PATH contienne le chemin
d'acces aux scripts de melina++, c'est a dire .../melina++/bin, ou ...
correspond a l'endroit ou est installe la bibliotheque. Dans l'exemple precedent,
il s'agit de : $HOME/melina++/bin

Pour que "ca marche" dans toutes les sessions ulterieures, le mieux est de modifier
(ou de creer) l'un des fichiers de configuration du shell :
- si le shell est le C-shell ou le T-shell, ajouter dans le fichier $HOME/.cshrc :
   set path = ($HOME/melina++/bin $path)
- en Bourne-shell ou en bash, ajouter dans le fichier $HOME/.profile :
   PATH=$HOME/melina++/bin:$PATH
   export PATH

Nota. Adapter bien sur le chemin en fonction du nom du repertoire d'installation.
      Ceci est a faire une fois pour toutes.

* Exploitation courante
Pour compiler et faire l'edition de liens de votre programme, il faut taper
dans le repertoire ou il se situe :

m+lnmake
 --> a faire une seule fois : cette commande cree un lien dans le repertoire
     courant vers le fichier makefile utile

make
 --> execute les commandes contenues dans ce fichier pour creer l'executable
     correspondant a votre programme (rappel : il ne doit y avoir qu'une seule
     fonction main dans tous les fichiers du repertoire). Tous les fichiers
     d'extension .c++ contenus dans le repertoire sont pris en compte.

                       ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~