Added README.md (#7)

README.md

@@ -1 +1,33 @@
-# contrib
+# Repository for OpenVINO's extra modules
+
+This repository is intended for the 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 OpenVINO distribution, since the library maintains backward compatibility, and tries to provide decent performance and stability.
+
+So, all the new modules should be developed separately, and published in the `openvino_contrib` repository at first. Later, when the module matures and gains popularity, it is moved to the central OpenVINO repository, and the development team provides production-quality support for this module.
+
+## How to build OpenVINO with extra modules
+You can build OpenVINO, 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 OpenVINO.
+
+Here is the CMake command for you:
+
+```sh
+$ cd <openvino_build_directory>
+$ cmake -DIE_EXTRA_MODULES=<openvino_contrib>/modules <openvino_source_directory>
+$ cmake --build . -j8
+```
+
+As the result, OpenVINO will be built in the <openvino_build_directory> with all modules from `openvino_contrib` repository. To disable specific modules, use CMake's `BUILD_<module_name>` boolean options. Like in this example:
+
+```sh
+$ cmake -DIE_EXTRA_MODULES=<openvino_contrib>/modules -DBUILD_java_api=OFF <openvino_source_directory>
+```
+
+## Update the repository documentation
+In order to keep a clean overview containing all contributed modules, the following files need to be created/adapted:
+
+* Update the [README.md](./modules/README.md) file under the [modules](./modules) folder. Here, you add your model with a single line description.
+
+* Add a README.md inside your own module folder. This README explains which functionality (separate functions) is available, explains in somewhat more detail what the module is expected to do. If any extra requirements are needed to build the module without problems, add them here also.
+
+## Contributing guidelines
+
+All guidelines for contributing to the OpenVINO repositories can be found at [How to contribute guideline](https://github.com/openvinotoolkit/openvino/wiki/Contribute).

modules/README.md

@@ -0,0 +1,9 @@
+# An overview of the openvino_contrib modules
+
+This list gives an overview of all modules available inside the contrib repository. To turn off building one of these module repositories, set the names in bold below to
+
+```sh
+$ cmake -DIE_EXTRA_MODULES=<openvino_contrib>/modules -DBUILD_<module name>=OFF <openvino_source_directory>
+```
+
+* [**java_api**](./java_api): Inference Engine Java API -- provides Java wrappers for Inference Engine public API.