Update README
This commit is contained in:
parent
43f9ca943f
commit
c57891b099
12
README.md
12
README.md
|
@ -1,4 +1,4 @@
|
||||||
##About
|
## About
|
||||||
|
|
||||||
This is a project for collecting the vulnerability evidence from source code repositories.
|
This is a project for collecting the vulnerability evidence from source code repositories.
|
||||||
|
|
||||||
|
@ -19,9 +19,9 @@ The project consists of two parts:
|
||||||
identify and track the potentially vulnerable coding.
|
identify and track the potentially vulnerable coding.
|
||||||
|
|
||||||
|
|
||||||
##Usage
|
## Usage
|
||||||
|
|
||||||
####Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
1. Java compiler and runtime (tested with jdk 1.8).
|
1. Java compiler and runtime (tested with jdk 1.8).
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ identify and track the potentially vulnerable coding.
|
||||||
3. MongoDB (tested with version 3.4)
|
3. MongoDB (tested with version 3.4)
|
||||||
* make sure the mongodb service is running
|
* make sure the mongodb service is running
|
||||||
|
|
||||||
####Building and packaging
|
#### Building and packaging
|
||||||
|
|
||||||
Building with Maven is pretty straightforward. The following commands are
|
Building with Maven is pretty straightforward. The following commands are
|
||||||
available:
|
available:
|
||||||
|
@ -44,7 +44,7 @@ each project.
|
||||||
|
|
||||||
3. "mvn clean" - deletes all temporary folders.
|
3. "mvn clean" - deletes all temporary folders.
|
||||||
|
|
||||||
####Basic usage
|
#### Basic usage
|
||||||
|
|
||||||
The project can be compiled into an executable jar library:
|
The project can be compiled into an executable jar library:
|
||||||
1. Execute the "mvn package" command
|
1. Execute the "mvn package" command
|
||||||
|
@ -70,7 +70,7 @@ IMPORTANT: if you are running the analysis using a .csv input file, please make
|
||||||
sure that the fields are specified in the exact order as shown above.
|
sure that the fields are specified in the exact order as shown above.
|
||||||
|
|
||||||
|
|
||||||
####MongoDB database
|
#### MongoDB database
|
||||||
|
|
||||||
There is no access control for the database, just make sure that the "bindIp"
|
There is no access control for the database, just make sure that the "bindIp"
|
||||||
setting is set to "127.0.0.1" which allows only local access (typically, this
|
setting is set to "127.0.0.1" which allows only local access (typically, this
|
||||||
|
|
Loading…
Reference in New Issue