-
Notifications
You must be signed in to change notification settings - Fork 5.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated version of main README #3872
Open
ronaldosc
wants to merge
8
commits into
opencv:4.x
Choose a base branch
from
ronaldosc:4.x
base: 4.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−45
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c51f44e
Update README.md
ronaldosc 1f05c4c
Update README.md
ronaldosc 6774ddf
Update README.md
ronaldosc 0ce2c47
Update README.md
ronaldosc d41b7e3
Update README.md
ronaldosc 67d858e
Update README.md
ronaldosc 0a18abb
Update README.md
ronaldosc e5d7b12
Merge branch '4.x' into 4.x
ronaldosc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,25 +15,26 @@ provides production-quality support for this module. | |
|
||
You can build OpenCV, so it will include the modules from this repository. Contrib modules are under constant development and it is recommended to use them alongside the master branch or latest releases of OpenCV. | ||
|
||
Here is the CMake command for you: | ||
>***Here is the CMake command line for you:*** | ||
|
||
``` | ||
$ cd <opencv_build_directory> | ||
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules <opencv_source_directory> | ||
$ make -j5 | ||
```bash | ||
cd <opencv_build_directory> | ||
cmake -D OPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules <opencv_source_directory> | ||
make -j5 | ||
``` | ||
|
||
As the result, OpenCV will be built in the `<opencv_build_directory>` with all | ||
modules from `opencv_contrib` repository. If you don't want all of the modules, | ||
use CMake's `BUILD_opencv_*` options. Like in this example: | ||
use CMake's `BUILD_opencv_*` option where * is the given name of a module as <reponame> in this example: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This is not accurate. This just confuses user. |
||
|
||
``` | ||
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules -DBUILD_opencv_legacy=OFF <opencv_source_directory> | ||
```bash | ||
cmake -D OPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules -D BUILD_opencv_<reponame>=OFF <opencv_source_directory> | ||
``` | ||
|
||
If you also want to build the samples from the "samples" folder of each module, also include the "-DBUILD_EXAMPLES=ON" option. | ||
If you also want to build the samples from the "samples" folder of each module, also include the `-D BUILD_EXAMPLES=ON` option. | ||
|
||
|
||
If you prefer using the GUI version of CMake (cmake-gui), then, you can add `opencv_contrib` modules within `opencv` core by doing the following: | ||
>***If you prefer using the GUI version of CMake (cmake-gui), then, you can add `opencv_contrib` modules within `opencv` core by doing the following:*** | ||
|
||
1. Start cmake-gui. | ||
|
||
|
@@ -50,6 +51,8 @@ If you prefer using the GUI version of CMake (cmake-gui), then, you can add `ope | |
7. Build the `opencv` core with the method you chose (make and make install if you chose Unix makefile at step 6). | ||
|
||
8. To run, linker flags to contrib modules will need to be added to use them in your code/IDE. For example to use the aruco module, "-lopencv_aruco" flag will be added. | ||
|
||
------ | ||
|
||
### Update the repository documentation | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not a mistake.