From 9c11df8859869a35719685fc741db427515ecfb3 Mon Sep 17 00:00:00 2001 From: Giovanni Grano Date: Tue, 22 Dec 2020 11:08:48 +0100 Subject: [PATCH] improved readme --- .gitignore | 3 ++- README.md | 7 +++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index a04adfe..38149ef 100644 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,5 @@ hs_err_pid* Output_TestSmellDetection* target/ TestSmellDetector.iml -files-smell.csv \ No newline at end of file +files-smell.csv +test-smells.csv \ No newline at end of file diff --git a/README.md b/README.md index a0c59d7..40b1759 100644 --- 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