diff --git a/doc/Doxyfile b/doc/Doxyfile index f3412789..915963f0 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -236,8 +236,7 @@ TAB_SIZE = 4 # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. +# newlines. ALIASES = @@ -1087,7 +1086,7 @@ CLANG_OPTIONS = # path to the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files # were built. This is equivalent to specifying the "-p" option to a clang tool, -# such as clang-check. These options will then be passed to the parser. +# such as clang-check. These options will then be pased to the parser. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: 0. @@ -1566,7 +1565,7 @@ MATHJAX_FORMAT = HTML-CSS # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. +# The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest @@ -2407,7 +2406,7 @@ INTERACTIVE_SVG = NO # found. If left blank, it is assumed the dot tool can be found in the path. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_PATH = /usr/local/bin/dot +DOT_PATH = "C:/Program Files (x86)/Graphviz2.38/bin" # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the \dotfile diff --git a/include/DGM.h b/include/DGM.h index c12246ef..80750ed0 100644 --- a/include/DGM.h +++ b/include/DGM.h @@ -179,35 +179,54 @@ Please refer to the @ref moduleVIS documentation /** @page s3 Installation -DGM is a cross-platform library which may be installed on Windows or MacOS machines. It was tested with MS Visual Studio and Xcode respectively.
-DGM has only one dependency: it is based on OpenCV library. -In order to build the DGM library, the OpenCV library (v.3.3.0 or newer) should be installed first. +DGM is a cross-platform C++ library. The description here was tested on Windows 10 / Visual Studio 2017 and MacOS High Sierra 10.13.6 / Xcode 9.4.1. If you encounter errors after following the steps described below, +feel free to contact us via our User Q&A forum. We'll do our best to help you out.
+ +DGM has only one dependency: it is based on OpenCV library. +In order to use the DGM library, the OpenCV library should be also installed. @section sec_install_cv Installing OpenCV --# Download the OpenCV library from sourcefourge --# Install the OpenCV library. You may follow the short installation guide or a deteiled - installation in Windows guide +- Download the latest version of the OpenCV library from https://www.opencv.org/releases.html +- Build and install the library. You may follow the following guidances: + - Installation in Windows guide or + - Installation in Linux guide @section sec_install_dgm Installing DGM --# Download the DGM library from Project X Research --# Unzip it to your local folder (for example to disk @b C:\\, so the library path will be @b C:\\DGM\\) --# In case you want to build the library follow these instructions, otherwise - skip this step - -# Download and install CMake - -# Run \b cmake-gui.exe - -# In the “Where is the source code” field choose the DGM source directory: \b C:\\DGM
- In the “Where to build the binaries” field choose directory for VS compiled DGM: \b C:\\DGM\\builds - -# Press \a Configure button and choose Visual Studio 14 2015 or Visual Studio 14 2015 Win64 (or whatever) as building environment - -# Be sure that the \a OpenCV_DIR is pointing to the OpenCV build directory (\a e.g. \b C:\\OpenCV\\build), where \b OpenCVConfig.cmake file is located - -# Press one more time \a Configure and then \a Generate, so the VS project will be generated in the \b C:\\DGM\\builds - -# Open the solution (\b C:\\DGM\\builds\\DGM.sln file) - -# Build \b ALL_BUILD and \b INSTALL projects first for \a Debug and then for \a Release configuration. That will copy DGM headers, binaries and demonstration applications to \b C:\\DGM\\builds\\install - -# (Optionally) you can copy the content of the \b C:\\DGM\\builds\\install to another folder, e.g. \b C:\\DGM\\build --# Specify the following paths and library - -# Add to Configuration Properties -> C/C++ -> General -> Additional Include Directories the path \b C:\\DGM\\build\\include - -# Add to Configuration Properties -> Linker -> General -> Additional Library Directories the path \b C:\\DGM\\build\\lib for both Release and Debug configurations - -# Add to Configuration Properties -> Linker -> Input -> Additional Dependencies the libraries \b dgm151.lib, \b fex151.lib, \b vis151.lib and \b dgm151d.lib, \b fex151d.lib, \b vis151d.lib - for Release and Debug configurations accordingly --# Copy the DGM dll files \b dgm151.dll, \b dgm151d.dll and \b fex151.dll, \b fex151d.dll and \b vis151.dll, \b vis151d.dll from @b C:\\DGM\\build\\bin to your project's Relese and Debug folders. +- Download either the latest stable DGM version from Project X Research + or fork the latest snapshot from our GitHub repository +- Unpack it to your local folder (for example to disk @b C:\\ for Windows or to @b /Users/username/ for MacOS, so the library path will be @b C:\\DGM\\ or @b /Users/username/DGM/) +@subsection sec_install_dgm_source Building DGM from Source Using CMake +In case you want to build the library (recommended), follow these instructions, otherwise - skip this step and proceed to @ref sec_install_dgm_built. +This step also assumes that you have downloaded the sources of the DGM library. +- Download and install CMake for your operating system +- Run \b cmake-gui.exe in Windows or \b CMake.app in MacOS +- In the “Where is the source code” field choose the DGM source directory: \b DGM
+ In the “Where to build the binaries” field choose directory where Visual Studio or Xcode project files will be generated: \a e.g. \b DGM/build +- Press \a Configure button and choose Visual Studio for using 32-bit compiler, Visual Studio Win64 for using 64-bit compiler or Xcode as building environment +- Be sure that the \a OpenCV_DIR is pointing to the OpenCV installation directory (\a e.g. \b OpenCV/build/install or \b /usr/local/share/OpenCV), where \b OpenCVConfig.cmake file is located +- (Optioanlly) you can change \a CMAKE_INSTALL_PREFIX to the directory where the DGM binaries will be installed (\a e.g. to \b DGM/build/install) +- Press one more time \a Configure and then \a Generate, so the IDE project files will be generated in the \b DGM/build +- Open the generated projectd by pressing the \a Open \a Project button or directly by opening file \b DGM/build/DGM.sln or \b DGM/build/DGM.xcodeproj +- Build \b ALL_BUILD and \b INSTALL projects first for \a Debug and then for \a Release configuration. That will copy DGM headers, binaries and demonstration applications to the install folder \b DGM/build/install +- Windows users may copy the OpenCV binaries into the install folder by executing script \b /DGM/build/install/bin/copyOpenCVDLL.bat +- (Optionally) you can copy the install folder with the ready-to-use DGM library (\a e.g. \b DGM/build/install) to any other folder + +@subsection sec_install_dgm_built Using the Pre-built Libraries +This step assumes that you have downloaded DGM-package with the pre-build binaries. In such case the type and version of the downloaded binaries should correspond to your C++ compiler. +If it is not, please return to the @ref sec_install_dgm_source section and generate the binaries with your compiler. The content of the install folder (\a e.g. \b DGM/build/install) will +correspond to the downloaded pre-build DGM package. + +@subsection sec_install_dgm_after After Installation +As soosn as the DGM library is installed, you can launch the demo applications from the \b /bin folder. If you have built the binaries from the sources, you can also start the demo projects directly from your IDE. +The corresponding description may be found in @ref demo. Do not hesitate to modify these demo projects for your needs or start your own project based on our demo code. + +If you wish to generate a new projects, which will use DGM, or add DGM to an existing project we highly recomend you to use CMake and follow the +Using DGM library with CMake guidances, where template \b CMakeLists.txt file is provided.
+Alternatively, you can specify the following paths and library in your IDE manually: +- Add to Configuration Properties -> C/C++ -> General -> Additional Include Directories the path \b install_folder/include +- Add to Configuration Properties -> Linker -> General -> Additional Library Directories the path \b install_folder/lib for both Release and Debug configurations +- Add to Configuration Properties -> Linker -> Input -> Additional Dependencies the libraries \b dgm160.lib, \b fex160.lib, \b vis160.lib and \b dgm160d.lib, \b fex160d.lib, \b vis160d.lib + for Release and Debug configurations accordingly */ /**