Skip to content

Enrich the README.md file with basic Markdown for nicer presentation on GitHub WebUI. #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enrich the README.md file with basic Markdown for nicer presentation on GitHub WebUI. #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
This is a simple flask app that parses RPM or SWID package lists and runs them through the NVD.

To get this working you will need to download a copy of the NVD here: https://nvd.nist.gov/download.cfm#CVE_FEED
and put the xml files in the dbs folder.

You can run download_xml.sh to do this for you automatically.

and put the `.xml` files in the `dbs/` folder. You can run `download_xml.sh` to do this for you automatically.

The command line interface is similar but outputs a JUnit style XML document for automated continuous integration.
To get the package list of your install:

yocto - Follow the instructions in the yocto manual and paste the contents of installed-packages.txt below.
rpm - run 'rpm -qa' in the terminal and paste the ouput below
other - 'pip install swid_generator && swid_generator swid' in the terminal and paste the output below

run package-cve-lookup -h for more information on using the command line interface
To get the package list of your install:

* **yocto** - follow the instructions in the yocto manual and paste the contents of `installed-packages.txt` below;
* **rpm** - run `rpm -qa` in the terminal and paste the ouput below;
* other - `pip install swid_generator && swid_generator swid` in the terminal and paste the output below.

Run `package-cve-lookup -h` for more information on using the command line interface.