Skip to content

Commit cb32c72

Browse files
Mikel CortesMikel Cortes
authored andcommitted
Update Readme with Tool updates
1 parent 653403c commit cb32c72

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ src/bin
99
# Ignore the example folder (personal to each user)
1010
examples/*
1111
# Ignore the example folder (personal to each user)
12-
results/*
12+
general-results/*
1313

1414
# Ignore System Files (from MAC)
1515
.DS_Store

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,21 @@ To use the tool the following tools needs to be installed on the machine:
99

1010
### Usage
1111
The crawler can be easily executed from the `armiarma.sh` file (make sure that is an executable file).
12-
The executable `armiarma.sh` launching shell script supports three different commands that correspond to the main functionalities of the tool.
12+
The executable `armiarma.sh` launching shell script supports five different commands that correspond to the main functionalities of the tool.
1313
Those commands are:
1414

1515
- `./armiarma.sh -h` to display the help text of the tool.
1616
- `./armiarma.sh -c [network] [project-name]` to launch the armiarma crawler on the given network. The given project-name is the name of the folder where the gathered metrics and where all the related information will be saved. The folder will be placed on the `./examples` folder.
1717
- `./armiarma.sh -p [project-name]` to launch the armiarma analyzer over the metrics from the given project. The generted plots of the analysis will be saved on the `./examples/[project-name]/plots` folder.
18+
- `./armiarma.sh -f [network] [project-name] [time]` to launch the armiarma crawler on the given network for the given `time` in minutes. The given project-name is the name of the folder where the gathered metrics and where all the related information will be saved. The folder will be placed on the `./examples` folder. After the crawling for the given time, the analyzer will be launched automatically. The summary results will be saved on the `./examples/[project-name]/plots` folder.
19+
- `./armiarma.sh -o` to launch the armiarma general overview analyzer over the metrics from the projects' folder. The generted results of the analysis will be saved on the `./general-resutls` folder.
1820

1921
```
2022
./armiarma.sh --> -h
2123
'-> -c [network] [project-name]
2224
'-> -p [project-name]
25+
'-> -f [network] [project-name] [time](minutes)
26+
'-> -o
2327
```
2428

2529
The tool will get the Go packages and compile Rumor as generate the virtual env and install the python3 dependencies for the user.

armiarma.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ LaunchGeneralResults(){
286286
# Run the Analyzer
287287
echo " Launching General Overview Analyzer"
288288
echo ""
289-
python3 ./src/analyzer/total-overview-analysis.py ./examples ./results
289+
python3 ./src/analyzer/total-overview-analysis.py ./examples ./general-results
290290
echo "results available in \$ARMIARMA/results"
291291
echo ""
292292
# Deactivate the VENV

0 commit comments

Comments
 (0)