8000 Make docs more clear [skip ci] [skip appveyor] · APCLab/opencv-python@be374d3 · GitHub
[go: up one dir, main page]

Skip to content
8000

Commit be374d3

Browse files
authored
Make docs more clear [skip ci] [skip appveyor]
1 parent 7b547cb commit be374d3

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,31 @@ OpenCV on wheels
1111

1212
**Unofficial** OpenCV packages for Python.
1313

14+
This repository generates packages which contain pre-compiled OpenCV binary with Python bindings. This enables super fast (usually < 10 seconds) OpenCV installation for Python.
15+
16+
If you need only OpenCV Python bindings, no separate OpenCV installation is required.
17+
18+
**IMPORTANT NOTE**
19+
20+
MacOS and Linux wheels have some limitations:
21+
22+
- video related functionality is not supported (not compiled with FFmpeg)
23+
- for example ``cv.imshow()`` will not work (not compiled with GTK+ 2.x or Carbon support)
24+
1425
Installation and Usage
1526
----------------------
1627

17-
To install this package:
28+
1. If you have previous/other version of OpenCV installed (e.g. cv2 module in the root of Python's site-packages), remove it before installation to avoid conflicts.
29+
- To further avoid conflicts and to make development easier, Python's `virtual environments <https://docs.python.org/3/library/venv.html>`__ are highly recommended for development purposes.
30+
2. Install this package:
1831

1932
``pip install opencv-python``
2033

21-
To import the package:
34+
3. Import the package:
2235

2336
``import cv2``
2437

25-
`OpenCV documentation <http://docs.opencv.org/>`__
26-
27-
IMPORTANT NOTE:
28-
29-
MacOS and Linux wheels have some limitations:
30-
31-
- video related functionality is not supported (not compiled with FFmpeg)
32-
- for example ``cv.imshow()`` will not work (not compiled with GTK+ 2.x or Carbon support)
38+
4. Read `OpenCV documentation <http://docs.opencv.org/>`__
3339

3440
Documentation for opencv-python
3541
-------------------------------
@@ -138,4 +144,4 @@ Currently, builds for following Python versions are provided:
138144
- 2.7
139145
- 3.4
140146
- 3.5
141-
- 3.6
147+
- 3.6

0 commit comments

Comments
 (0)
290F
0