Skip to content

Commit

Permalink
improvement on the README
Browse files Browse the repository at this point in the history
  • Loading branch information
giograno committed Jan 23, 2021
1 parent bd19468 commit 5f46e44
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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.
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.

Expand All @@ -38,4 +38,6 @@ Options:
detection
-o, --output TEXT
-h, --help Show this message and exit
```
```

[Spadini et.al.]: https://dl.acm.org/doi/abs/10.1145/3379597.3387453

0 comments on commit 5f46e44

Please sign in to comment.