Skip to content

Commit cb37380

Browse files
authored
Update README.md
1 parent b16b8c1 commit cb37380

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,50 @@ java -jar ARCODE_JAR_FILE -framework FRAMEWORK_OF_INTEREST -fspecOutputPath PATH
4444
- **PATH_TO_FRAMEWORK_JAR_FILE:** Path to jar file of the framework of interest.
4545
- **PACKAGE_NAME_OF_FRAMEWORK:** Since there might be more than one framework in a jar file, we introduce the packaging of the framework through this property. For instance, in case of JAAS framework, this package would be javax/security/auth. Also, framework package for RMI would be java/rmi.
4646

47+
## Running the tool on a Windoes-based machine
48+
Assuming that you are using a Windows-based machine, here are the steps you need to follow to be able to run the tool for JAAS framework:
49+
1. Cloning the source code in a path (e.g. on drive D):
50+
```
51+
D:\>git clone https://github.com/SoftwareDesignLab/ArCode.git
52+
```
53+
2. Building the tool:
54+
```
55+
D:\ArCode\Implementation\arcode\>mvn clean package
56+
```
57+
3. Running the tool:
58+
```
59+
D:\ArCode\Implementation\arcode\target>java -jar arcode-1.0-SNAPSHOT-jar-with-dependencies.jar -framework JAAS -fspecOutputPath D:\ArCode\DataRepository\JAAS -trainProjectsPath D:\ArCode\DataRepository\JAAS\Train -testProjectsPath D:\ArCode\DataRepository\JAAS\Test -exclusionFilePath D:\ArCode\Implementation\arcode\config\JAASJavaExclusions.txt -frameworkJarPath D:\ArCode\Frameworks\JAAS.jar -frameworkPackage javax/security/auth
60+
```
61+
Also, in case that you want to run the tool for RMI framework, you can easily run the followig command:
62+
```
63+
D:\ArCode\Implementation\arcode\target>java -jar arcode-1.0-SNAPSHOT-jar-with-dependencies.jar -framework RMI -fspecOutputPath D:\ArCode\DataRepository\RMI -trainProjectsPath D:\ArCode\DataRepository\RMI\Train -testProjectsPath D:\ArCode\DataRepository\RMI\Test -exclusionFilePath D:\ArCode\Implementation\arcode\config\JAASJavaExclusions.txt -frameworkJarPath D:\ArCode\Frameworks\RMI.jar -frameworkPackage java/rmi
64+
```
65+
66+
## Running the tool on a Mac OS:
67+
Assuming that you are using a Mac machine, here are the steps you need to follow to be able to run the tool for JAAS framework:
68+
1. Cloning the source code in a path (e.g. on drive D):
69+
```
70+
/Users/YOUR_USERNAME/Desktop/ArCode$ git clone https://github.com/SoftwareDesignLab/ArCode.git
71+
```
72+
2. Building the tool:
73+
```
74+
/Users/YOUR_USERNAME/Desktop/ArCode/Implementation/arcode$ mvn clean package
75+
```
76+
3. Running the tool:
77+
```
78+
/Users/YOUR_USERNAME/Desktop/ArCode/Implementation/arcode/target$ java -jar arcode-1.0-SNAPSHOT-jar-with-dependencies.jar -framework JAAS -fspecOutputPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/JAAS -trainProjectsPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/JAAS/Train -testProjectsPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/JAAS/Test -exclusionFilePath /Users/YOUR_USERNAME/Desktop/ArCode/Implementation/arcode/config/JAASJavaExclusions.txt -frameworkJarPath /Users/YOUR_USERNAME/Desktop/ArCode/Frameworks/JAAS.jar -frameworkPackage javax/security/auth
79+
```
80+
Also, in case that you want to run the tool for RMI framework, you can easily run the followig command:
81+
```
82+
/Users/YOUR_USERNAME/Desktop/ArCode/Implementation/arcode/target$ java -jar arcode-1.0-SNAPSHOT-jar-with-dependencies.jar -framework RMI -fspecOutputPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/RMI -trainProjectsPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/RMI/Train -testProjectsPath /Users/YOUR_USERNAME/Desktop/ArCode/DataRepository/RMI/Test -exclusionFilePath /Users/YOUR_USERNAME/Desktop/ArCode/Implementation/arcode/config/JAASJavaExclusions.txt -frameworkJarPath /Users/YOUR_USERNAME/Desktop/ArCode/Frameworks/RMI.jar -frameworkPackage java/rmi
83+
```
84+
85+
#
4786
If you faced out of memory or heap-related exceptiones, you may need to increase the run-time memory by adding the following option to the above command:
4887
```
4988
-Xms512M -Xmx512M
5089
```
90+
5191
While running the tool, there might be some WARNING logs in the console. As long as you are not receiving SEVERE, ERROR, or Exception messages you should be fine.
5292

5393
After running ArCode, four folders in training as well as testing projects' directories will be created.

0 commit comments

Comments
 (0)