Skip to content

Commit 4ea43a2

Browse files
committed
Explain dev and test dependencies in README
1 parent 20e1564 commit 4ea43a2

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,21 +95,34 @@ utils/testvectors_lowcost.py
9595
utils/testvectors_unlinkable.py
9696
```
9797

98-
## Running the tests
98+
## Development
9999

100-
To run the tests, install `pytest` (e.g., `pip install pytest`) and then run
101-
`pytest`. You may need to reload the `venv` (`deactivate` followed by `source
102-
venv/bin/ativate`) to ensure that the paths are picked up correctly.
100+
For development, you should install the development and test dependencies:
103101

104-
## Development
102+
```bash
103+
pip install -e ".[dev,test]"
104+
```
105105

106-
Please install the proper pre-commit-hooks so that the files stay formatted:
106+
You should also install the proper pre-commit-hooks so that the files stay
107+
formatted:
107108

108109
```bash
109110
pip install pre-commit
110111
pre-commit install
111112
```
112113

114+
### Running the tests
115+
116+
To run the tests, simply call
117+
118+
```bash
119+
pytest
120+
```
121+
122+
If you just installed the test dependencies, you may need to reload the `venv`
123+
(`deactivate` followed by `source venv/bin/ativate`) to ensure that the paths
124+
are picked up correctly.
125+
113126
## License
114127

115128
This code is licensed under the Apache 2.0 license, as found in the LICENSE

0 commit comments

Comments
 (0)