Skip to content

Commit bad9466

Browse files
committed
update README
1 parent 58be065 commit bad9466

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,17 @@ In addition to any variables that OpenCV's build accepts, we recognize:
118118
- ``ENABLE_CONTRIB`` and ``ENABLE_HEADLESS``. Set to ``1`` to build the contrib and/or headless version
119119
- ``CMAKE_ARGS``. Additional arguments for OpenCV's CMake invocation. You can use this to make a custom build.
120120

121+
### Manual builds
122+
123+
If some dependency is not enabled in the pre-built wheels, you can also run the `setup.py` locally to create a custom wheel.
124+
125+
1. Clone this repository: `git clone --recursive https://github.com/skvark/opencv-python.git`
126+
2. Go to the root of the repository
127+
3. Add custom Cmake flags if needed, for example: `export CMAKE_FLAGS="-DSOME_FLAG=ON -DSOME_OTHER_FLAG=OFF"`
128+
4. Run ``python setup.py bdist_wheel``
129+
- Optionally use the `manylinux` images as a build hosts if maximum portability is needed (and run `auditwheel` for the wheel after build)
130+
5. You'll have the wheel file in the `dist` folder and you can do with that whatever you wish (upload to local PyPI index, use as dependency in a CI job which runs the PyInstaller / PyOxidizer bundler for your app etc.)
131+
121132
### Licensing
122133

123134
Opencv-python package (scripts in this repository) is available under MIT license.
@@ -132,6 +143,8 @@ Linux wheels ship with [Qt 4.8.7](http://doc.qt.io/qt-4.8/lgpl.html) licensed un
132143

133144
MacOS wheels ship with [Qt 5](http://doc.qt.io/qt-5/lgpl.html) licensed under the [LGPLv3](http://www.gnu.org/licenses/lgpl-3.0.html).
134145

146+
The packages include also other binaries. Full list of licenses can be found from [LICENSE-3RD-PARTY.txt](https://github.com/skvark/opencv-python/blob/master/LICENSE-3RD-PARTY.txt).
147+
135148
### Versioning
136149

137150
``find_version.py`` script searches for the version information from OpenCV sources and appends also a revision number specific to this repository to the version string.
@@ -168,3 +181,10 @@ Currently, builds for following Python versions are provided:
168181
- 3.6
169182
- 3.7
170183
- 3.8
184+
185+
### Backward compatibility
186+
187+
Starting from 4.2.0 and 3.4.9 builds the macOS Travis build environment was updated to XCode 9.4. The change effectively dropped support for older than 10.13 macOS versions.
188+
189+
Starting from 4.3.0 and 3.4.10 builds the Linux build environment was updated from `manylinux1` to `manylinux2014`. This dropped support for old Linux distributions.
190+

0 commit comments

Comments
 (0)