Prechádzať zdrojové kódy

Completion et correction readme

Loquicom 5 rokov pred
rodič
commit
f2ecf4aee7
1 zmenil súbory, kde vykonal 51 pridanie a 5 odobranie
  1. 51 5
      README.md

+ 51 - 5
README.md

@@ -10,7 +10,7 @@ La documentation suivante pars du principe qu'un terminal est ouvert dans le dos
 
 ## Partie 0 - Paramétrage et Déploiement
 
-Le projet est composé de plusieurs programme avec la même base. Pour exécuter les scripts propre à chaque programme il faut utiliser la commande suivante :
+Le projet est composé de plusieurs programmes avec la même base. Pour exécuter les scripts propres à chaque programme il faut utiliser la commande suivante :
 
 ```bash
 npm start <program> <script>
@@ -24,11 +24,11 @@ Pour séparer chaque programme en un ensemble de fichier indépendant il faut la
 npm run deploy
 ```
 
-Un dossier seras crée avec le nom de chaque programme dans le dossier `dist` (si il n'existe pas il seras crée).
+Un dossier sera créé avec le nom de chaque programme dans le dossier `dist` (si il n'existe pas il sera créé).
 
 Chaque dossier comportera ses sources, son package.json et son README.md.
 
-Le parametrage des différents projets (les scripts, la version, les dépendances, ...) sont paramétrable depuis le fichier deploy.json
+Le paramétrage des différents projets (les scripts, la version, les dépendances, ...) sont paramétrables depuis le fichier deploy.json
 
 ## Partie 1 - Recherche des co-auteurs d'un auteur
 
@@ -122,7 +122,7 @@ node coauth.js --process ./data/dblp.xml
 
 Les temps d'executions des commandes sur nos PC sont de :
 
-|                 | Ubuntu (PC Fac) | Kubuntu                | Kde Neon (I7-8550U)   |
+|                 | Ubuntu (PC Fac) | Kubuntu (I5-7300HQ)    | Kde Neon (I7-8550U)   |
 | --------------- | --------------- | ---------------------- | --------------------- |
 | **Référence**   |                 | ?                      | environ 2 minutes 30  |
 | **Préparation** |                 | environ 2 minutes      | environ 1 minute 45   |
@@ -130,4 +130,50 @@ Les temps d'executions des commandes sur nos PC sont de :
 
 ## Partie 2
 
-blabla
+L'objectif du programme est de générer un document XML avec les infos extraites des articles et des inproceedings d'un auteur donné dans la base de données DBLP au format XML. Le document comporte aussi une section avec tous les co-auteurs de l'auteur donné dans les données extraites.
+
+### Commande d'extraction des données
+
+La commande pour extraire les données de la base est la suivante (en dessous son équivalent avec npm) : 
+
+```bash
+node extract.js
+# <=>
+npm start
+```
+
+Par défaut le programme va chercher le fichier XML de la base dans le dossier data avec le nom dblp.xml et créer un fichier extract.xml dans ce même dossier. Le nom de l'auteur sera demandé dans la console avant de lancer la recherche.
+
+Le programme possède 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 de la base (en XML)
+- `-o <source>` ou `--output <string>` ou `--output=<string>` : Pour indiquer le chemin pour la création du fichier contenant les données de l'extraction (en XML)
+- `-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
+
+Voici quelques exemples et leur explication de la commande avec ces options :
+
+```bash
+# Recherche les informations sur Fabien Delorme dans la base ./data/dblp.xml et extrait les informations dans ./data/extract.xml
+node extract.js --name "Fabien Delorme"
+
+# Recherche les informations sur Fabien Delorme dans la base ./data/dblp.xml et extrait les informations dans ./data/fabienDelorme.xml
+node extract.js --name="Fabien Delorme" --output "./data/fabienDelorme.xml"
+
+# Recherche les informations sur Fabien Delorme dans la base ./data/base.xml et extrait les informations dans ./data/extract.xml
+node extract.js -n "Fabien Delorme" -o "./data/fabienDelorme.xml" -f "./data/base.xml"
+
+# Recherche les informations sur Fabien Delorme dans la base ./data/base.xml et extrait les informations dans ./data/extract.xml et affiche des informations sur l'exécution
+node extract.js -n "Fabien Delorme" -o "./data/fabienDelorme.xml" -f "./data/base.xml" -v
+```
+
+
+
+### Temps d'exécution
+
+|                | Ubuntu (PC Fac) | Kubuntu (I5-7300HQ) | KDE Neon (I7-8550U)     |
+| -------------- | --------------- | ------------------- | ----------------------- |
+| **Extraction** |                 |                     | entre 45 et 50 secondes |
+