Skip to content

Commit

Permalink
docs: add cmd for installing the cve-tool in virtualenv
Browse files Browse the repository at this point in the history
In the contribution guide for running the [local copy of cve-bin-tool](https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-your-local-copy-of-cve-binary-tool)  ,the mentioned cmd for installing the tool works when a user is not in a virtual env. When present in virtual env , the --user flag isn't needed. 
This PR attempts to clearly mention the cmds for both the cases.
  • Loading branch information
ayushthe1 committed Dec 20, 2023
1 parent 5cfa0da commit 7497b18
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,16 @@ One of the reasons we suggest virtualenv is that it makes it easier to do this s

If you want to run a local copy of cve-bin-tool, the recommended way is to install it locally. From the cve-bin-tool main directory, run:

### If not in a virtual environment
```bash
python3 -m pip install --user -e .
```

### If in a virtual environment
```bash
python3 -m pip install -e .
```

Then you can type `cve-bin-tool` on the command line and it will do the right thing. This includes some special code intended to deal with adding new checkers to the list on the fly so things should work seamlessly for you while you're building new contributions.

## Help, my checkers aren't loading
Expand Down

0 comments on commit 7497b18

Please sign in to comment.