Closed
Description
I was reminded by #3065 that we're due for a revamp out of README.md file. In theory, this file should serve as a quick overview for new users to the tool so they can see if it does what they need and set it up. In practice, we've got a lot of documentation in there that should maybe be moved around.
Some thoughts from a quick scan:
- Data sources descriptions could probably be changed to a short list or table (as with the checkers) and links to appropriate sections in MANUAL.md (we will need to keep the NVD_API_KEY info up near the top of the doc, though)
- Language-specific checkers could similarly be reduced to names + links. We might want to have a table listing what specific files we're able to scan for each language. e.g.
| Language | Files scanned | More documentation |
|---|---|---|
| Python | Requirements.txt, .whl, .egg, METADATA, PKG-INFO | Link to docs |
| Ruby | Gemfile.lock | Link to docs |
- system dependencies info may need to be moved up to go with the "how to install" section
But there's probably more that could be streamlined. If anyone else has any suggestions, feel free to chime in. I particularly appreciate feedback from folk who learned how to use the tool recently.