Update README

This commit is contained in:
standash 2019-06-04 14:20:15 +02:00
parent 43f9ca943f
commit c57891b099
1 changed files with 6 additions and 6 deletions

View File

@ -1,4 +1,4 @@
##About
## About
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.
##Usage
## Usage
####Prerequisites
#### Prerequisites
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)
* make sure the mongodb service is running
####Building and packaging
#### Building and packaging
Building with Maven is pretty straightforward. The following commands are
available:
@ -44,7 +44,7 @@ each project.
3. "mvn clean" - deletes all temporary folders.
####Basic usage
#### Basic usage
The project can be compiled into an executable jar library:
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.
####MongoDB database
#### MongoDB database
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