Recent changes to readme_developer

readme_developer modified by Loïc Sauter

Loïc Sauter — Fri, 15 Jan 2021 18:41:00 -0000

--- v9
+++ v10
@@ -28,7 +28,7 @@

 ##### 1.00
 - Fix  last bugs, and add documentation 
--  It is ok to give this software to the customer
+-  It is ok to give this software to the customers

 #### 0.18

readme_developer modified by Loïc Sauter

Loïc Sauter — Fri, 15 Jan 2021 18:40:04 -0000

--- v8
+++ v9
@@ -25,6 +25,10 @@

 ### Version :
+
+##### 1.00
+- Fix  last bugs, and add documentation 
+-  It is ok to give this software to the customer

 #### 0.18

@@ -82,8 +86,8 @@
 - [Daniel_TCHATCHOUANG_OUOKAM](daniel.tchatchouang_ouokam@utt.fr)
 - [Noémie_HAMMANN](noemie.hammann@utt.fr)

-#Phase 3 (maintenance vX.XX)
- - [Shiqi_Gao](shiqi.gao@utt.fr)
+#Phase 3 (maintenance v1.00)
+- [Shiqi_Gao](shiqi.gao@utt.fr)
  - [Ludovic_Marquès](ludovic.marques@utt.fr)
  - [Loïc_Sauter](loic.sauter@utt.fr)

readme_developer modified by Loïc Sauter

Loïc Sauter — Fri, 15 Jan 2021 18:37:07 -0000

--- v7
+++ v8
@@ -5,7 +5,9 @@
 - Toutes les commandes se trouvent dans le dossier `./command` avec leur nom respectif
 - Les données (fichiers des tweets en .csv) doivent se trouver dans `./data`
 - `./index.js` fichier caporal qui gère et centralise toutes les commandes
-- Les fichiers qu'on retrouve dans le dossier `function` sont les fonctions utilisées par les différentes commandes.
+- Les fichiers qu'on retrouve dans le dossier `./function` sont les fonctions utilisées par les différentes commandes.
+
+#### Par Exemple

 ```bash

readme_developer modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:42:22 -0000

--- v6
+++ v7
@@ -1,4 +1,4 @@
-## GL02  Readme Develloper
+## GL02  Readme Developer

 ## Les commandes/ fonctions

readme_developer modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:42:13 -0000

readme_developer modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:41:51 -0000

readme_develloper modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:33:41 -0000

--- v3
+++ v4
@@ -85,17 +85,5 @@
  - [Ludovic_Marquès](ludovic.marques@utt.fr)
  - [Loïc_Sauter](loic.sauter@utt.fr)

-### TO DO
-
-1. La commande de recherche `RECH` n'a pas pu être finalisée dans les temps impartis. (FAIT)
-
-2. La commande `EXTR` d'extraction de tweets n'a pas pu être commencée car elle dépend de la commande de recherche. (FAIT)
-
-3. Specifies the final maintenance version
-
-4. Ajouter des graphiques et des fichiers .txt pour les fonctions `refHash` et `nbTweetHashtag`
-
-5. Ajouter la fonction check pour vérifier si les fichiers .csv sont lisibles


-

readme_develloper modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:33:15 -0000

--- v2
+++ v3
@@ -1,4 +1,26 @@
 ## GL02  Readme Develloper
+
+## Les commandes/ fonctions
+
+- Toutes les commandes se trouvent dans le dossier `./command` avec leur nom respectif
+- Les données (fichiers des tweets en .csv) doivent se trouver dans `./data`
+- `./index.js` fichier caporal qui gère et centralise toutes les commandes
+- Les fichiers qu'on retrouve dans le dossier `function` sont les fonctions utilisées par les différentes commandes.
+
+```bash
+
+`./getAllTweet.js` retourne la liste de tout les tweets parsés du dossier `./data`
+```
+
+```bash
+node index.js check
+
+utilise la fonction validParsedTweets() de `./getAllTweet.js` et retourne le nombre de tweets trouvé
+```
+
+
+
+

 ### Version :

readme_develloper modified by Loïc Sauter

Loïc Sauter — Mon, 11 Jan 2021 15:07:14 -0000

--- v1
+++ v2
@@ -1,65 +1,79 @@
-# GL02 Project
+## GL02  Readme Develloper

-It's the Tweet part
-We must improve the code implemented by an other group.
+### Version :

-- Our Group is 
+#### 0.18

-* Shiqi Gao
-* Ludovic Marques
-* Sauter Loïc
+- Add some documentation to the `tenHashtag`

-## **The TO DO List is :**
+#### 0.17
+
+- Add `check` function to check if the software can find the differents csv files in the `./data` folder
+
+#### 0.16
+
+- Add charts and .txt file for the functions `refHash` and `nbTweetHashtag`
+- Create a file `./creatChart.js` for all the charts
+
+#### 0.15
+
+- Add `searchTweet` and `extractTweet` documentation
+- `No results found bug` solved
+
+#### 0.14
+
+- 'searchTweet' command implementation finished
+- 'extractTweet' command implementation finished
+
+#### 0.12
+
+- Start the implementation of the 'extractTweet' command
+
+#### 0.10
+
+- Start the implementation of the 'searchTweet' command
+
+#### 0.09
+
+- Add some documentation
+
+#### 0.00 - 0.07
+
+Command implemented:
+- check
+- viz-fd
+- viz-fld
+- topTenTweet
+- topTenAuthor
+- nbTweetHashtag
+- refHash
+
+- Start the documentation
+
+## List of Contributors
+
+#Phase 2 (implementation v0.07)
+- [Elina_ROBERT](elina.robert@utt.fr)
+- [Franck_Emmanuel_FOTSO_TALLA](franck_emmanuel.fotso_talla@utt.fr)
+- [Daniel_TCHATCHOUANG_OUOKAM](daniel.tchatchouang_ouokam@utt.fr)
+- [Noémie_HAMMANN](noemie.hammann@utt.fr)
+
+#Phase 3 (maintenance vX.XX)
+ - [Shiqi_Gao](shiqi.gao@utt.fr)
+ - [Ludovic_Marquès](ludovic.marques@utt.fr)
+ - [Loïc_Sauter](loic.sauter@utt.fr)
+
+### TO DO
+
+1. La commande de recherche `RECH` n'a pas pu être finalisée dans les temps impartis. (FAIT)
+
+2. La commande `EXTR` d'extraction de tweets n'a pas pu être commencée car elle dépend de la commande de recherche. (FAIT)
+
+3. Specifies the final maintenance version
+
+4. Ajouter des graphiques et des fichiers .txt pour les fonctions `refHash` et `nbTweetHashtag`
+
+5. Ajouter la fonction check pour vérifier si les fichiers .csv sont lisibles



-We must correct the test no validate Tests from the recipe doc :
-
-https://docs.google.com/document/d/1Xl-Db6_5ONla95EJX4IRQw8wfibrgHpWveGvvySkPpQ/edit
-
-that is to say we must finish :
-
- - test1_6 ; 
-
-Select the proportion of hastags from the data files
-and in output we want a chart with the propotion of the main/all hashtag 
-(in bonus maybe a text file with the same data)
-
-
-- test1_7 ;
-
-Improve the nbTweetHashtag methode (is only work with a given hastag and a given periode) we want also for the all hashtag and period
-give the total nbr of the tweets for a given period 
-
-
-
-- test2_5 ;
-
-give the top 10 (or the top <n>) of the Hastag mentionned
-and creat a chart and a txt file with this data
-
-
-- test2_6;
-
-improve the method refHash we have only the function with the data in the console
-add txt file and a chart with this data.
-
-
----
- 
-## The adding part
-
--  rech function 
-
-like in the readEmail for our projet 
-filter all the tweet in fonction of the filter
-
-- extr function 
-
-add a parameter in the rech function to be able to extract the data filter in a txt file
-
-also like the readEmail method
-
-
-
-
</n>

readme modified by GAOSHIQI

GAOSHIQI — Mon, 11 Jan 2021 13:56:31 -0000

GL02 Project

It's the Tweet part
We must improve the code implemented by an other group.

Our Group is
Shiqi Gao
Ludovic Marques
Sauter Loïc

The TO DO List is :

We must correct the test no validate Tests from the recipe doc :

https://docs.google.com/document/d/1Xl-Db6_5ONla95EJX4IRQw8wfibrgHpWveGvvySkPpQ/edit

that is to say we must finish :

test1_6 ;

Select the proportion of hastags from the data files
and in output we want a chart with the propotion of the main/all hashtag
(in bonus maybe a text file with the same data)

test1_7 ;

Improve the nbTweetHashtag methode (is only work with a given hastag and a given periode) we want also for the all hashtag and period
give the total nbr of the tweets for a given period

test2_5 ;

give the top 10 (or the top <n>) of the Hastag mentionned
and creat a chart and a txt file with this data</n>

test2_6;

improve the method refHash we have only the function with the data in the console
add txt file and a chart with this data.

The adding part

rech function

like in the readEmail for our projet
filter all the tweet in fonction of the filter

extr function

add a parameter in the rech function to be able to extract the data filter in a txt file

also like the readEmail method