Prechádzať zdrojové kódy

Adaption doc pour mieux repondre à la partie 1

Loquicom 5 rokov pred
rodič
commit
2ed6a3bd95
1 zmenil súbory, kde vykonal 36 pridanie a 31 odobranie
  1. 36 31
      README.md

+ 36 - 31
README.md

@@ -64,11 +64,43 @@ Le paramétrage des différents projets (les scripts, la version, les dépendanc
 
 ## Partie 1 - Recherche des co-auteurs d'un auteur
 
-L'objectif du programme est de trouver les co-auteurs d'un auteur donné. Le programme possède deux fonctions, la première permet de faire un pré-traitement de la base dans un fichier .ppf (Pre Processing File), le second permet d'effectuer la recherche depuis le fichier obtenu suite au pré-traitement.
+L'objectif du programme est de trouver les co-auteurs d'un auteur donné. Le programme possède deux fonctions, la première permet de faire un pré-traitement de la base dans un fichier .ppf (Pre Processing File), le second permet d'effectuer la recherche depuis le fichier obtenu suite au pré-traitement ou depuis.
+
+### Commande de recherche des co-auteurs sans pré-traitement
+
+La commande de base pour la recherche des co-auteurs sans pré-traitement est la suivante :
+
+```bash
+node coauth.js -p <source>
+```
+
+
+
+L'option `-p <source>` ou `--process <source>`permet d'effectuer une recherche des co-auteurs sans faire d'abord un pré-traitement. `<source>` correspond au chemin vers le fichier de base de données en XML. 
+
+Il est possible d'utiliser l'option `-n <string>` ou `--name <string>` ou `--name=<string>` pour indiquer le nom de l'auteur pour la recherche. Si l'option est absente le nom est demandé dans la console.
+
+Voici quelques exemples expliqués de la commande avec l'option process :
+
+```bash
+# Lance le pré-traitement sur le fichier ./data/dblp.xml, génere le fichier ./data/data.ppf et le nom de l'auteur pour la recherche est demandé dans la console
+node coauth.js --process ./data/dblp.xml
+
+# Lance le pré-traitement sur le fichier ./data/dblp.xml, génere le fichier ./data/data.ppf et fait la recherche sur Fabien Delorme
+node coauth.js -p ./data/dblp.xml -n "Fabien Delorme"
+```
+
+Une commande avec npm est aussi disponible, elle est équivalente à la commande en dessous d'elle. Le nom de l'auteur pour la recherche est demandé dans la console lors de l'execution.
+
+```bash
+npm run process
+# <=>
+node coauth.js --process ./data/dblp.xml
+```
 
 ### Commande de pré-traitement de la base
 
-Cette commande permet de générer un fichier .ppf (si aucune destination n'est indiquée le chemin vers le fichier seras le quivant : `./data/data.ppf`)
+Cette commande permet de générer un fichier .ppf (si aucune destination n'est indiquée le chemin vers le fichier seras le suivant : `./data/data.ppf`)
 
 La commande est :
 
@@ -89,9 +121,7 @@ node coauth.js prepare ./data/dblp.xml ./data/data.ppf
 
 ### Commande de recherche des co-auteurs
 
-La recherche des co-auteurs ne peut avoir lieu qu'après avoir executé une fois la commande de pré-traitement car elle nécéssite un fichier .ppf pour fonctionner
-
-La commande de base est la suivante :
+La commande de base pour la recherche des co-autheurs est la suivante :
 
 ```bash
 node coauth.js
@@ -102,7 +132,7 @@ Avec cette commande le programme considère que le fichier .ppf est dans `./data
 La commande admet plusieurs options :
 
 - `-n <string>` ou `--name <string>` ou `--name=<string>` : Pour indiquer le nom de l'auteur pour la recherche
-- `-f <source>` ou `--file <string>` ou `--file=<string>` : Pour indiquer le chemin vers le fichier .ppf à utiliser
+- `-f <source>` ou `--file <source>` ou `--file=<source>` : Pour indiquer le chemin vers le fichier .ppf à utiliser
 - `-v` ou `--verbose` : Permet d'afficher plus d'informations dans la console
 - `-h` ou `--help` : Affiche l'aide
 - `-V` ou `--version` : Affiche la version du programme
@@ -125,31 +155,6 @@ npm start
 node coauth.js -f "./data/data.ppf"
 ```
 
-### Commande d'éxecution du pré-traitement puis de la recherche
-
-En ajoutant l'option `-p <source>` ou `--process <source>` il est possible d'effectuer le pré-traitement puis une recherche des co-auteurs. `<source>` correspond au chemin vers le fichier de base de données en XML. De plus l'option process est utilisable avec les autres options du programme, la seul différence est que l'option file sert en plus à indiquer le chemin pour créer le fichier de pré-traitement (fichier qui seras utilisé pour la recherche).
-
-Voici quelques exemples expliqués de la commande avec l'option process :
-
-```bash
-# Lance le pré-traitement sur le fichier ./data/dblp.xml, génere le fichier ./data/data.ppf et le nom de l'auteur pour la recherche est demandé dans la console
-node coauth.js --process ./data/dblp.xml
-
-# Lance le pré-traitement sur le fichier ./data/dblp.xml, génere le fichier ./data/data.ppf et fait la recherche sur Fabien Delorme
-node coauth.js -p ./data/dblp.xml -n "Fabien Delorme"
-
-# Lance le pré-traitement sur le fichier ./data/dblp.xml, génere le fichier ./tmp/coauth.ppf et fait la recherche sur Fabien Delorme
-node coauth.js -p ./data/dblp.xml -n "Fabien Delorme" -f ./tmp/coauth.ppf
-```
-
-Une commande avec npm est aussi disponible, elle est équivalente à la commande en dessous d'elle. Le nom de l'auteur pour la recherche est demandé dans la console lors de l'execution.
-
-```bash
-npm run process
-# <=>
-node coauth.js --process ./data/dblp.xml
-```
-
 ### Temps d'exécution
 
 Les temps d'executions des commandes sur nos PC sont de :