-
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
base: 4.x
Are you sure you want to change the base?
Changes from all commits
c51f44e
1f05c4c
6774ddf
0ce2c47
d41b7e3
67d858e
0a18abb
e5d7b12
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. 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. Sure, you're correct. The name of repo consists in the same name's module, right? |
||
|
||
``` | ||
$ 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 | ||
|
||
|
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.
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.
I know that. But for the best practices and DX the -D separated is more readable.