User guide modified by Théo Pennerat

Théo Pennerat — Mon, 11 Jan 2021 13:43:38 -0000

--- v1
+++ v2
@@ -1 +1,27 @@
-TEST
+Basic explanations of the software :
+
+INSTALLATION :
+
+Some files/directory are necessary to the correct operation of the software :
+
+    - the results folder contains files that the user decided to export. This folder should be created before any extraction.
+    - the package.json file is needed to install the required packages in the node_modules folder. To do that, the user should type "npm install" in the cmd
+
+Once the installation is complete, it is possible to start using the software.
+
+UTILISATION:
+
+The first command to type in the command line interpreter is `node caporalCli.js --help`
+    --> It will show all existing commands and a short desciption for each command
+If a user want to know more information about a command, he can type `node caporalCli.js <commandname> -h`
+    -->It will print the different arguments and options and a short description.
+The user should now be able to type his own commands thanks to the help command given previously
+
+Here are some test commands so that the user knows how to do:
+    
+    - node caporalCli.js numberTweet ./testFiles/fichierBienFormé.csv eaw18 "03 19 2018-00:01:01" "03 24 2018-00:01:01" -g -s
+    - node caporalCli.js listTweet ./testFiles/fichierBienFormé.csv eaw18 -a pmhswe
+    - node caporalCli.js mostRtFromHashtag eaw18 ./testFiles/fichierBienFormé.csv -g -s
+    - node caporalCli.js authors ./testFiles/fichierBienFormé.csv eaw18 -s
+    - node caporalCli.js tweetsByPlace ./testFiles/fichierBienFormé.csv -s -g
+    - node caporalCli.js listHashtag ./testFiles/fichierBienFormé.csv eaw18 -s
</commandname>

User guide modified by Théo Pennerat

Théo Pennerat — Mon, 11 Jan 2021 13:32:49 -0000

TEST

Recent changes to User guide

User guide modified by Théo Pennerat

User guide modified by Théo Pennerat