Skip to content

Commit f51e6c2

Browse files
committed
chore(all): a bit of usage doc
1 parent 09b000a commit f51e6c2

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,26 @@ A Python library meant at reproducing as exactly as possible the behavior of Zoo
1111

1212
## Installation
1313

14-
You can install the package directly from GitHub:
14+
You can install the package directly from GitHub, it is advised to use a tag, not main.
1515

1616
```bash
17-
pip install git+https://github.com/ecotaxa/ZooProcess-lib.git
17+
pip install git+https://github.com/ecotaxa/ZooProcess-lib.git@v0.1.0
1818
```
1919

2020
Or clone the repository and install locally:
2121

2222
```bash
23-
git clone https://github.com/YOUR_USERNAME/ZooProcess-lib.git
23+
git clone https://github.com/ecotaxa/ZooProcess-lib.git@v0.1.0
2424
cd ZooProcess-lib
2525
pip install -e .
2626
```
2727

28+
In requirements.txt it should look like:
29+
30+
'''
31+
ZooProcess-lib@git+https://github.com/ecotaxa/ZooProcess-lib.git@v0.1.0
32+
'''
33+
2834
## Requirements
2935

3036
- Python 3.12 or higher
@@ -41,13 +47,16 @@ For complete detailed examples, please see the tests directory, especially test_
4147

4248
### Running Tests
4349

50+
**Note**: You should install manually 'gdown' package before running tests. It's used to download big example TIFF files from a public GDrive folder.
51+
4452
```bash
45-
pytest tests/
53+
cd tests
54+
python -m pytest --ignore UNUSED/
4655
```
4756

4857
## License
4958

50-
This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.
59+
See the [LICENSE](LICENSE.txt) file for details.
5160

5261
## Contributing
5362

0 commit comments

Comments
 (0)