Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix URL (git install) and package name (pip install)
  • Loading branch information
TheGroundZero committed Jul 26, 2019
1 parent f1d51e5 commit ce4dfef
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Expand Up @@ -35,30 +35,35 @@ At this moment in time, the script only output .xlsx documents in one format, th

## Installation

# install requirements
# Install requirements
apt(-get) install python3 python3-pip # Debian, Ubuntu
yum -y install python3 python3-pip # CentOS
dnf install python3 python3-pip # Fedora
pip3 install -r requirements.txt
# clone repo
git clone git@github.com:TheGroundZero/openvas_to_report.git
# Clone repo
git clone https://github.com/TheGroundZero/openvasreporting.git
# Install module
cd openvasreporting
pip3 install .


Alternatively, you can install the package through the Python package installer 'pip'.
Alternatively, you can install the package through the Python package installer 'pip'.
This currently has some issues (see #4)

# Install pip
# Install pip3
apt(-get) install python3 python3-pip # Debian, Ubuntu
yum -y install python3 python3-pip # CentOS
dnf install python3 python3-pip # Fedora
# Install the package
pip install OpenVAS-Reporting
pip3 install OpenVAS-Reporting


## Usage

# When working from the Git repo
python3 -m openvasreporting -i [OpenVAS xml file(s)] [-o [Output file]] [-f [Output format]] [-l [minimal threat level (n, l, m, h, c)]] [-f [docx template]]
# When using the pip package
OpenVAS-Reporting -i [OpenVAS xml file(s)] [-o [Output file]] [-f [Output format]] [-l [minimal threat level (n, l, m, h, c)]] [-f [docx template]]
openvasreporting -i [OpenVAS xml file(s)] [-o [Output file]] [-f [Output format]] [-l [minimal threat level (n, l, m, h, c)]] [-f [docx template]]

### Parameters

Expand Down

0 comments on commit ce4dfef

Please sign in to comment.