Commit 95ec9299 authored by Vadim Pisarevsky's avatar Vadim Pisarevsky

Merge pull request #3536 from mshabunin:doxygen-intro

parents d9f159a5 06c2a70c
.. note:: .. note::
Unfortunetly we have no tutorials into this section. And you can help us with that, since OpenCV is a community effort. If you have a tutorial suggestion or you have written a tutorial yourself (or coded a sample code) that you would like to see here, please contact follow these instructions: :ref:`howToWriteTutorial` and :how_to_contribute:`How to contribute <>`. Unfortunetly we have no tutorials into this section. And you can help us with that, since OpenCV is a community effort. If you have a tutorial suggestion or you have written a tutorial yourself (or coded a sample code) that you would like to see here, please contact follow these instructions: :how_to_contribute:`How to contribute <>`.
How to write a tutorial for OpenCV {#tutorial_how_to_write_a_tutorial}
==================================
@todo new tutorial guide needed
...@@ -6,140 +6,138 @@ Additionally you can find very basic sample source code to introduce you to the ...@@ -6,140 +6,138 @@ Additionally you can find very basic sample source code to introduce you to the
- @subpage tutorial_linux_install - @subpage tutorial_linux_install
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Ana Huamán _Author:_ Ana Huamán
We will learn how to setup OpenCV in your computer! We will learn how to setup OpenCV in your computer!
- @subpage tutorial_linux_gcc_cmake - @subpage tutorial_linux_gcc_cmake
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Ana Huamán _Author:_ Ana Huamán
We will learn how to compile your first project using gcc and CMake We will learn how to compile your first project using gcc and CMake
- @subpage tutorial_linux_eclipse - @subpage tutorial_linux_eclipse
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Ana Huamán _Author:_ Ana Huamán
We will learn how to compile your first project using the Eclipse environment We will learn how to compile your first project using the Eclipse environment
- @subpage tutorial_windows_install - @subpage tutorial_windows_install
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Bernát Gábor _Author:_ Bernát Gábor
You will learn how to setup OpenCV in your Windows Operating System! You will learn how to setup OpenCV in your Windows Operating System!
- @subpage tutorial_windows_visual_studio_Opencv - @subpage tutorial_windows_visual_studio_Opencv
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Bernát Gábor _Author:_ Bernát Gábor
You will learn what steps you need to perform in order to use the OpenCV library inside a new You will learn what steps you need to perform in order to use the OpenCV library inside a new
Microsoft Visual Studio project. Microsoft Visual Studio project.
- @subpage tutorial_windows_visual_studio_image_watch - @subpage tutorial_windows_visual_studio_image_watch
*Compatibility:* \>= OpenCV 2.4 _Compatibility:_ \>= OpenCV 2.4
*Author:* Wolf Kienzle _Author:_ Wolf Kienzle
You will learn how to visualize OpenCV matrices and images within Visual Studio 2012. You will learn how to visualize OpenCV matrices and images within Visual Studio 2012.
- @subpage tutorial_java_dev_intro - @subpage tutorial_java_dev_intro
*Compatibility:* \> OpenCV 2.4.4 _Compatibility:_ \> OpenCV 2.4.4
*Authors:* Eric Christiansen and Andrey Pavlenko _Authors:_ Eric Christiansen and Andrey Pavlenko
Explains how to build and run a simple desktop Java application using Eclipse, Ant or the Explains how to build and run a simple desktop Java application using Eclipse, Ant or the
Simple Build Tool (SBT). Simple Build Tool (SBT).
- @subpage tutorial_java_eclipse - @subpage tutorial_java_eclipse
*Compatibility:* \> OpenCV 2.4.4 _Compatibility:_ \> OpenCV 2.4.4
*Author:* Barış Evrim Demiröz _Author:_ Barış Evrim Demiröz
A tutorial on how to use OpenCV Java with Eclipse. A tutorial on how to use OpenCV Java with Eclipse.
- @subpage tutorial_clojure_dev_intro - @subpage tutorial_clojure_dev_intro
*Compatibility:* \> OpenCV 2.4.4 _Compatibility:_ \> OpenCV 2.4.4
*Author:* Mimmo Cosenza _Author:_ Mimmo Cosenza
A tutorial on how to interactively use OpenCV from the Clojure REPL. A tutorial on how to interactively use OpenCV from the Clojure REPL.
- @subpage tutorial_android_dev_intro - @subpage tutorial_android_dev_intro
*Compatibility:* \> OpenCV 2.4.2 _Compatibility:_ \> OpenCV 2.4.2
*Author:* Vsevolod Glumov _Author:_ Vsevolod Glumov
Not a tutorial, but a guide introducing Android development basics and environment setup Not a tutorial, but a guide introducing Android development basics and environment setup
- @subpage tutorial_O4A_SDK - @subpage tutorial_O4A_SDK
*Compatibility:* \> OpenCV 2.4.2 _Compatibility:_ \> OpenCV 2.4.2
*Author:* Vsevolod Glumov _Author:_ Vsevolod Glumov
OpenCV4Android SDK: general info, installation, running samples OpenCV4Android SDK: general info, installation, running samples
- @subpage tutorial_dev_with_OCV_on_Android - @subpage tutorial_dev_with_OCV_on_Android
*Compatibility:* \> OpenCV 2.4.3 _Compatibility:_ \> OpenCV 2.4.3
*Author:* Vsevolod Glumov _Author:_ Vsevolod Glumov
Development with OpenCV4Android SDK Development with OpenCV4Android SDK
- @subpage tutorial_ios_install - @subpage tutorial_ios_install
*Compatibility:* \> OpenCV 2.4.2 _Compatibility:_ \> OpenCV 2.4.2
*Author:* Artem Myagkov, Eduard Feicho _Author:_ Artem Myagkov, Eduard Feicho
We will learn how to setup OpenCV for using it in iOS! We will learn how to setup OpenCV for using it in iOS!
- @subpage tutorial_arm_crosscompile_with_cmake - @subpage tutorial_arm_crosscompile_with_cmake
*Compatibility:* \> OpenCV 2.4.4 _Compatibility:_ \> OpenCV 2.4.4
*Author:* Alexander Smorkalov _Author:_ Alexander Smorkalov
We will learn how to setup OpenCV cross compilation environment for ARM Linux. We will learn how to setup OpenCV cross compilation environment for ARM Linux.
- @subpage tutorial_display_image - @subpage tutorial_display_image
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Ana Huamán _Author:_ Ana Huamán
We will learn how to display an image using OpenCV We will learn how to display an image using OpenCV
- @subpage tutorial_load_save_image - @subpage tutorial_load_save_image
*Compatibility:* \> OpenCV 2.0 _Compatibility:_ \> OpenCV 2.0
*Author:* Ana Huamán _Author:_ Ana Huamán
We will learn how to save an Image in OpenCV...plus a small conversion to grayscale We will learn how to save an Image in OpenCV...plus a small conversion to grayscale
- @subpage tutorial_how_to_write_a_tutorial - @subpage tutorial_documentation
*Compatibility:* \> OpenCV 1.0 _Compatibility:_ \> OpenCV 3.0
*Author:* Bernát Gábor _Author:_ Maksim Shabunin
If you already have a good grasp on using OpenCV and have made some projects that would be This tutorial describes new documenting process and some useful Doxygen features.
perfect presenting an OpenCV feature not yet part of these tutorials, here it is what you
need to know.
...@@ -293,26 +293,6 @@ world of the OpenCV. ...@@ -293,26 +293,6 @@ world of the OpenCV.
:height: 90pt :height: 90pt
:width: 90pt :width: 90pt
* **Want to contribute, and see your own work between the OpenCV tutorials?**
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|HowToWriteT| **Title:** :ref:`howToWriteTutorial`
*Compatibility:* > OpenCV 1.0
*Author:* |Author_BernatG|
If you already have a good grasp on using OpenCV and have made some projects that would be perfect presenting an OpenCV feature not yet part of these tutorials, here it is what you need to know.
=============== ======================================================
.. |HowToWriteT| image:: images/how_to_write_a_tutorial.png
:height: 90pt
:width: 90pt
.. raw:: latex .. raw:: latex
\pagebreak \pagebreak
...@@ -337,4 +317,3 @@ world of the OpenCV. ...@@ -337,4 +317,3 @@ world of the OpenCV.
../crosscompilation/arm_crosscompile_with_cmake ../crosscompilation/arm_crosscompile_with_cmake
../display_image/display_image ../display_image/display_image
../load_save_image/load_save_image ../load_save_image/load_save_image
../how_to_write_a_tutorial/how_to_write_a_tutorial
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment