Skip to content

Commit

Permalink
Added README and modules folder
Browse files Browse the repository at this point in the history
  • Loading branch information
Kirill Kornyakov committed Sep 11, 2013
1 parent 3a8ca88 commit e3aa8bf
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 3 deletions.
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.c text
*.cpp text
*.h text
*.hpp text
*.txt text
*.mk text
*.java text
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
opencv_contrib
==============
## Repository for OpenCV's extra modules

Repository for OpenCV's extra modules
This repository is intended for development of so-called "extra" modules,
contributed functionality. New modules quite often do not have stable API,
and they are not well-tested. Thus, they shouldn't be released as a part of
official OpenCV distribution, since the library maintains binary compatibility,
and tries to provide decent performance and stability.

So, all the new modules should be developed separately, and published in the
`opencv_contrib` repository at first. Later, when the module matures and gains
popularity, it is moved to the central OpenCV repository, and the development team
provides production quality support for this module.

### How to build OpenCV with extra modules

You can build OpenCV, so it will include the modules from this repository.
Here is the CMake command for you:

```
$ cd <opencv_build_directory>
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib> <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:

```
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib> -DBUILD_opencv_legacy=OFF <opencv_source_directory>
```
1 change: 1 addition & 0 deletions modules/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please put your module here.

0 comments on commit e3aa8bf

Please # to comment.