From 66c3d01f4bcf926b85b903f80dbb405a35cf606b Mon Sep 17 00:00:00 2001 From: Jan Pazdziora Date: Mon, 28 May 2018 12:13:02 +0200 Subject: [PATCH] Enrich the README.md file with basic Markdown for nicer presentation on GitHub WebUI. --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5794175..63b2eab 100644 --- a/README.md +++ b/README.md @@ -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.