Merge pull request #110 from StevenPuttemans/fix_contrib_README

adding more clear documentation

README.md

@@ -45,3 +45,11 @@ If you prefer using the gui version of cmake (cmake-gui), then, you can add `ope
 6. press the `configure` button followed by the `generate` button (the first time, you will be asked which makefile style to use)
 
 7. build the `opencv` core with the method you chose (make and make install if you chose Unix makfile at step 6) 
+
+### Update the repository documentation
+
+In order to keep a clean overview containing all contributed modules the following files need to be created/adapted.
+
+1. Update the README.md file under the modules folder. Here you add your model with a single line description.
+
+2. Add a README.md inside your own module folder. This README explains which functionality (seperate functions) is available, links to the corresponding samples and 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.

modules/README.md

@@ -1 +1,49 @@
-Please put your module here.
+An overview of the contrib modules and a small explanation
+----------------------------------------------------------
+
+This list gives an overview of all modules available inside the contrib repository.
+These are also the correct names for disabling the building of a specific module by adding
+
+```
+$ cmake -D OPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules -D BUILD_opencv_reponame=OFF <opencv_source_directory>
+```
+
+1. **opencv_adas**: Advanced Driver Assistance Systems module with Forward Collision Warning.
+
+2. **opencv_bgsegm**: Improved Adaptive Background Mixture Model for Real-time Tracking / Visual Tracking of Human Visitors under Variable-Lighting Conditions.
+
+3. **opencv_bioinspired**: Biologically inspired vision models and derivated tools.
+
+4. **opencv_ ccalib**: Custom Calibration Pattern for 3D reconstruction.
+
+5. **opencv_cvv**: GUI for Interactive Visual Debugging of Computer Vision Programs.
+
+6. **opencv_datasettools**: Tools for working with different datasets.
+
+7. **opencv_face**: Recently added face recognition software which is not yet stabalized.
+
+8. **opencv_line_descriptor**: Binary descriptors for lines extracted from an image.
+
+9. **opencv_matlab**: OpenCV Matlab Code Generator.
+
+10. **opencv_optflow**: Optical Flow Algorithms for tracking points.
+
+11. **opencv_reg**: Image Registration module.
+
+12. **opencv_rgbd**: RGB-Depth Processing module.
+
+13. **opencv_saliency**: Saliency API, understanding where humans focus given a scene.
+
+14. **opencv_surface_matching**: Surface Matching Algorithm Through 3D Features.
+
+15. **opencv_text**: Scene Text Detection and Recognition in Natural Scene Images.
+
+16. **opencv_tracking**: Long-term optical tracking API.
+
+17. **opencv_xfeatures2d**: Extra 2D Features Framework containing experimental and non-free 2D feature algorithms.
+
+18. **opencv_ximgproc**: Extended Image Processing: Structured Forests / Domain Transform Filter / Guided Filter / Adaptive Manifold Filter / Joint Bilateral Filter / Superpixels.
+ 
+19. **opencv_xobjdetect**: Integral Channel Features Detector Framework.
+
+20. **opencv_xphoto**: Additional photo processing algorithms: Color balance / Denoising / Inpainting.

modules/adas/README.md

@@ -0,0 +1,2 @@
+ADAS: Advanced Driver Assistance Systems module with Forward Collision Warning
+==============================================================================

modules/bgsegm/README.md

@@ -0,0 +1,5 @@
+Improved Background-Foreground Segmentation Methods 
+===================================================
+
+1. Adaptive Background Mixture Model for Real-time Tracking
+2. Visual Tracking of Human Visitors under Variable-Lighting Conditions.

modules/bioinspired/README.md

@@ -0,0 +1,2 @@
+Biologically inspired vision models and derivated tools
+=======================================================

modules/ccalib/README.md

@@ -0,0 +1,2 @@
+Custom Calibration Pattern for 3D reconstruction
+================================================

modules/cvv/README.md

@@ -1,2 +1,2 @@
-CVVisual
-========
+GUI for Interactive Visual Debugging of Computer Vision Programs
+================================================================

modules/datasetstools/README.md

@@ -0,0 +1,2 @@
+Tools for working with different datasets
+=========================================

modules/face/README.md

@@ -0,0 +1,2 @@
+Recently added face recognition software
+========================================

modules/line_descriptor/README.md

@@ -0,0 +1,2 @@
+Binary descriptors for lines extracted from an image
+====================================================

modules/optflow/README.md

@@ -0,0 +1,2 @@
+Optical Flow Algorithms for tracking points
+===========================================

modules/reg/README.md

@@ -1,4 +1,5 @@
-# OpenCV pixel-intensity based registration module
+OpenCV pixel-intensity based registration module
+================================================
 
 Author and maintainer: Alfonso Sanchez-Beato
                        alfonsosanchezbeato\_\_\_\_gmail.com

modules/rgbd/README.md

@@ -0,0 +1,2 @@
+ RGB-Depth Processing module
+============================

modules/saliency/README.md

@@ -1,4 +1,5 @@
-# Saliency Module
+Saliency API, understanding where humans focus given a scene
+============================================================
 
 The purpose of this module is to create, group and make available to the users, different saliency algorithms, belonging to different categories.
 

modules/surface_matching/README.md

@@ -0,0 +1,2 @@
+Surface Matching Algorithm Through 3D Features
+==============================================

modules/text/README.md

@@ -0,0 +1,3 @@
+Scene Text Detection and Recognition in Natural Scene Images
+============================================================
+

modules/tracking/README.md

@@ -0,0 +1,3 @@
+Long-term optical tracking API
+==============================
+

modules/xfeatures2d/README.md

@@ -0,0 +1,5 @@
+Extra 2D Features Framework
+===========================
+
+1. Experimental 2D feature algorithms
+2. Non-free 2D feature algorithms

modules/ximgproc/README.md

@@ -0,0 +1,9 @@
+Extended Image Processing
+=========================
+
+1. Structured Forests 
+2. Domain Transform Filter
+3. Guided Filter
+4. Adaptive Manifold Filter
+5. Joint Bilateral Filter
+6. Superpixels

modules/xobjdetect/README.md

@@ -0,0 +1,3 @@
+Integral Channel Features Detector Framework
+============================================
+

modules/xphoto/README.md

@@ -0,0 +1,7 @@
+Additional photo processing algorithms
+======================================
+
+1. Color balance
+2. Denoising
+3. Inpainting
+