Skip to content
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
wants to merge 8 commits into
base: 4.x
Choose a base branch
from
Open

Updated version of main README #3872

wants to merge 8 commits into from

Conversation

ronaldosc
Copy link

This PR is a correction in some commands in main documentation.

Were edited the commands for bash for default and deleted the "$" for best copy & paste.

ronaldosc added 8 commits June 5, 2023 16:06
formatting update
Added a line next to end to separate the two instructions, the last one is for addition of new module ones.
@ronaldosc ronaldosc changed the title Updated version of README Updated version of main README Jan 16, 2025
Copy link

@opencv-alalek opencv-alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't accept PRs with massive "changes for changes" without significant "added value".

```

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:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reponame

This is not accurate. This just confuses user.
<module> should be used instead.

Ref: https://docs.opencv.org/4.x/db/d05/tutorial_config_reference.html#tutorial_config_reference_general_modules

$ make -j5
```bash
cd <opencv_build_directory>
cmake -D OPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules <opencv_source_directory>

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants