improved readme

TestSmells · Dec 22, 2020 · 9c11df8 · 9c11df8
1 parent 45f334b
commit 9c11df8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -26,4 +26,5 @@ hs_err_pid*
 Output_TestSmellDetection*
 target/
 TestSmellDetector.iml
-files-smell.csv
+files-smell.csv
+test-smells.csv
diff --git a/README.md b/README.md
@@ -21,6 +21,13 @@ Visit the project website: https://testsmells.github.io/
 
 Running the jar with `--help` will print its usage.
 
+* A CSV input file always need to be given as parameter, specified with `-f`;
+* A detection threshold can also be specified. Possible values are `default` and `spadini`. The flag is `-t`.
+By default, the tool uses the thresholds that have been originally implemented; 
+with `spadini`, sensibility thresholds published by Spadini et.al. will be used.
+* One can specify the granularity of the detection. `boolean` will return either true or false, respectively if a 
+given smell is present or not in the test; `numerical` will return instead the number of smelly instances detected.  
+
 ```
 Options:
   -f, --file PATH                  The csv input file