Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ For each potential rule, the rule validator will take as inputs :
- a file containing the "bad code" (code smell)
- a file containing the test scenarios to be executed.

For each scenario, the rule validator will instrumente it with monitoring tools (actually only one - vjoule) and will generate some results file.
For each scenario, the rule validator will instrumente it with monitoring tools (actually only one - vjoule) and will generate some results file (csv files).

You can find some generated sample files in the folder **/samples**.

Based on those results file, a graphic summary is generated for each rule.
Based on those results files, a graphic summary is generated for each rule using 'graph_generator.py'.
'graph_generator.py' takes as input the previously generated csv results file, and based on that file, an html page containing the comparison graph is generated. Note that this script takes the name of the compared function as an input argument. the csv file name AND the first cell of its content must be that function name.