Merge pull request #183 from alicevision/doc/conanFirst

[doc] add conan documentation

Author: simogasp

CHANGES.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- Added documentation for conan [PR](https://github.com/alicevision/CCTag/pull/183)
 
 ### Changed
 

INSTALL.md

@@ -2,6 +2,7 @@
 
 ## Building instructions
 
+For a detailed guide on building the library check the [online documentation](https://cctag.readthedocs.io/).
 
 Required tools:
 * CMake >= 3.14 to build the code
@@ -14,12 +15,6 @@ Optional tool:
 * CUDA >= 9.0 
 Note: On Windows, there are compatibility issues to build the GPU part due to conflicts between msvc/nvcc/thrust/eigen/boost.
 
-### Getting the sources:
-
-```shell
-$ git clone https://github.com/alicevision/CCTag.git
-```
-
 ###  Dependencies
 
 Most of the dependencies can be installed from the common repositories (apt, yum etc):
@@ -29,30 +24,6 @@ Most of the dependencies can be installed from the common repositories (apt, yum
 - OpenCV >= 3.1
 - TBB >= 4.0
 
-On a recent Ubuntu-like distribution (e.g. 14.04), you may want to try to run:
-```shell
-$ sudo apt-get install g++ git-all libpng12-dev libjpeg-dev libeigen3-dev libboost-atomic-dev libboost-chrono-dev libboost-date-time-dev libboost-dev libboost-program-options-dev libboost-exception-dev libboost-filesystem-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev libboost-timer-dev libtbb-dev
-```
-
-OpenCV need to be compiled separately and installed in some `OPENCV_INSTALL` path. Then, when running cmake you need to provide the path to the location where `OpenCVConfig.cmake` is installed, usually `${OPENCV_INSTALL}/share/share/OpenCV/` (see below).
-
-CCTag contains code optimized for AVX2  instruction set, which significantly increases detection performance. You can enable it with the option: `cmake -DCCTAG_ENABLE_SIMD_AVX2=ON`.
-
-----------
-
-### Run the building process
-
-You now just need to be in the CCTag folder and run cmake:
-```bash
-$ mkdir build && cd build
-$ cmake .. -DOpenCV_DIR=${OPENCV_INSTALL}/share/share/OpenCV/
-$ make -j `nproc`
-```
-
-Use `-DCCTAG_WITH_CUDA:BOOL=ON` to enable (default) or disable the cuda support. On Windows, it must be set to `OFF` if the Eigen version is < 3.3.9
-
-If you want to install the library to, say, a CCTAG_INSTALL path, just add `-DCMAKE_INSTALL_PREFIX=$CCTAG_INSTALL` at cmake command line.
-If you want to build CCTag as a shared library: `-DBUILD_SHARED_LIBS=ON`.
 
 ----------
 

doc/sphinx/source/conf.py

@@ -52,7 +52,7 @@ def configure_doxyfile(input_dir, output_dir):
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['breathe', 'sphinxcontrib.bibtex']
+extensions = ['breathe', 'sphinxcontrib.bibtex', 'sphinx.ext.autosectionlabel']
 bibtex_bibfiles = ['biblio.bib']
 
 # Add any paths that contain templates here, relative to this directory.

doc/sphinx/source/install/install.rst

@@ -47,6 +47,7 @@ CCTag depends on the following libraries:
 
 ------------
 
+CCTag can be installed from the following package managers.
 
 vcpkg
 =====
@@ -63,6 +64,22 @@ where :code:`cuda` and :code:`apps` are the options to build the library with th
 
 ------------
 
+
+conan
+=====
+
+`conan <https://conan.io/>`_ is a decentralized and multi-platform package manager.
+
+Since v1.0.1, you can install CCTag from conan by running:
+
+.. code:: shell
+
+  conan install cctag/1.0.1@
+
+where :code:`1.0.1@` is the version you want to install. See :ref:`CCTag as third party` for how to use CCTag as third party in your project.
+
+------------
+
 Building the library
 ====================
 
@@ -214,7 +231,7 @@ So if you do not want to build the Cuda part, you have to pass :code:`-DCCTAG_WI
 
 ------------
 
-
+.. _how-to-use:
 CCTag as third party
 ====================
 
@@ -241,6 +258,26 @@ Then, in order to build just pass the location of :code:`CCTagConfig.cmake` from
 
     cmake .. -DCCTag_DIR=$CCTAG_INSTALL/lib/cmake/CCTag/
 
+If you are using conan for your project then you need to add cctag to your :code:`conanfile.txt`:
+
+.. code::
+
+    [requires]
+    cctag/1.0.1
+
+    [generators]
+    CMakeToolchain
+    CMakeDeps
+
+and when building you may need to follow these steps:
+
+.. code:: shell
+
+    mkdir build
+    cd build
+    conan install .. -s build_type=Release
+    cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
+    cmake --build . --config Release
 
 ------------
 
@@ -267,7 +304,7 @@ For example to create the dependency image based on ubuntu 18.04 with cuda 8.0 f
 
     docker build --build-arg CUDA_TAG=8.0 --tag alicevision/cctag-deps:cuda8.0-ubuntu18.04 -f Dockerfile_deps .
 
-The complete list of available tags can be found on the nvidia [dockerhub page](https://hub.docker.com/r/nvidia/cuda/)
+The complete list of available tags can be found on the nvidia `dockerhub page <https://hub.docker.com/r/nvidia/cuda/>`_
 
 
 Building the CCTag image