Skip to content

Commit deb4127

Browse files
committed
Improve Windows installation docs
1 parent 6778f6f commit deb4127

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ pip install 'git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&sub
2929
```
3030

3131

32-
The package officially supports Python 3.6+.
32+
The package officially supports Python 3.6+ and was tested under Linux platform.
33+
For Windows based Anaconda distribution
34+
you might also need to install *shapely* package separately:
35+
36+
```console
37+
conda install shapely
3338

3439
For further steps please have a look at the [tutorial](https://superannotate.readthedocs.io/en/latest/tutorial.sdk.html).
3540

docs/source/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,13 @@ for COCO annotation format converters support also need to install:
5454
pip install 'git+https://github.com/cocodataset/panopticapi.git'
5555
pip install 'git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI'
5656
57-
The package officially supports Python 3.6+.
57+
The package officially supports Python 3.6+ and was tested under Linux platform.
58+
For Windows based Anaconda distribution
59+
you might also need to install :py:obj:`shapely` package separately:
60+
61+
.. code-block:: bash
62+
63+
conda install shapely
5864
5965
For further steps please have a look at the :ref:`tutorial <ref_tutorial>`.
6066

docs/source/tutorial.sdk.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,13 @@ for COCO annotation format converters support also need to install:
2424
pip install 'git+https://github.com/cocodataset/panopticapi.git'
2525
pip install 'git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI'
2626
27-
The package officially supports Python 3.6+.
27+
The package officially supports Python 3.6+ and was tested under Linux platform.
28+
For Windows based Anaconda distribution
29+
you might also need to install :py:obj:`shapely` package separately:
30+
31+
.. code-block:: bash
32+
33+
conda install shapely
2834
2935
----------
3036

0 commit comments

Comments
 (0)