Skip to content

Commit 6fb221b

Browse files
committed
Added info about script in README
Added info on uv pip install in README
1 parent c0e6553 commit 6fb221b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,18 @@ pip install coverage coveralls
4949
python -m pytest --cov=src
5050
```
5151

52+
You can also run the script to generate a local file `coverage.txt` with the same information by doing:
53+
```sh
54+
./scripts/generate_coverage_txt.sh
55+
```
56+
5257
## Development
5358

5459
The plugin is still under development. If you would like to contribute, install the package in editable mode (with the added `-e` flag) with the development dependencies:
5560

5661
```sh
57-
pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
62+
pip install uv
63+
uv pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple --system
5864
```
5965

6066
### Setting up plugin on your local installation

0 commit comments

Comments
 (0)