Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit be374d3

Browse filesBrowse files
authored
Make docs more clear [skip ci] [skip appveyor]
1 parent 7b547cb commit be374d3
Copy full SHA for be374d3

File tree

1 file changed

+17
-11
lines changed
Filter options

1 file changed

+17
-11
lines changed

‎README.rst

Copy file name to clipboardExpand all lines: README.rst
+17-11Lines 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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.