Skip to content

Commit

Permalink
Fix spelling errors in README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Dan Ryan <dan.ryan@canonical.com>
  • Loading branch information
techalchemy committed Dec 17, 2020
1 parent d3d3e9a commit 9041250
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]
### Added
- Corrected spelling issues in `CHANGELOG.md`
- Corrected spelling issues in `CHANGELOG.md` and `README.md`
- Ability to read a manifest file from stdin.
- Manifests can include an explicit Ubuntu codename if the update-manager-core
package is not installed.
Expand Down
48 changes: 26 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,24 +169,24 @@ The recommended way to install CVEScan is with `sudo snap install cvescan`
#### Install in local environment
The following commands will install and run CVEScan from source:

```bash
$> sudo apt install python3-pip
$> git clone https://github.com/canonical/sec-cvescan
$> pip3 install --user ./sec-cvescan/
$> ~/.local/bin/cvescan
```
$> sudo apt install python3-pip
$> git clone https://github.com/canonical/sec-cvescan
$> pip3 install --user sec-cvescan/
$> ~/.local/bin/cvescan
```

#### Install in a virtualenv
The following commands will install and run CVEScan from source in a virtualenv:

```
$> sudo apt install python3-pip git
$> pip3 install --user virtualenv
$> git clone https://github.com/canonical/sec-cvescan
$> ~/.local/bin/virtualenv -p python3 venv
$> source venv/bin/activate
$> pip3 install -e ./sec-cvescan[apt]
$> venv/bin/cvescan
#### Install in a virtual environment
The following commands will install and run CVEScan from source in a python virtual environment:

```bash
$> sudo apt install python3-pip git
$> pip3 install --user virtualenv
$> git clone https://github.com/canonical/sec-cvescan
$> ~/.local/bin/virtualenv -p python3 venv
$> source venv/bin/activate
$> pip3 install -e ./sec-cvescan[apt]
$> venv/bin/cvescan
```

## Development
Expand All @@ -195,25 +195,29 @@ $> venv/bin/cvescan

CVEScan can be run from the source code with `python3 -m cvescan`

### Installing precommit hooks
### Installing pre-commit hooks

To install the precommit hooks, run
To install the pre-commit hooks, run

pip3 install --user pre-commit
~/.local/bin/pre-commit install
```bash
$> pip3 install --user pre-commit
$> ~/.local/bin/pre-commit install
```

### Running the test suite

You can run the automated test suite by running

python3 setup.py test
```bash
$> python3 setup.py test
```

An HTML code coverage report will be generated at `./htmlcov`. You can view
this with any web browser (e.g. `firefox ./htmlcov/index.html`).

### Version numbers
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

The version number used by the setup.py, snapcraft.yaml, and `cvescan
The version number used by the `setup.py`, `snapcraft.yaml`, and `cvescan
--version` argument is stored in [cvescan/version.py](./cvescan/version.py) and
must be updated manually when a new version of CVEScan is released.

0 comments on commit 9041250

Please sign in to comment.