diff --git a/openbr/openbr_export.cpp b/openbr/openbr_export.cpp index f6bab66..7654907 100644 --- a/openbr/openbr_export.cpp +++ b/openbr/openbr_export.cpp @@ -45,8 +45,7 @@ * - \subpage windows_msvc * - \subpage windows_mingw * - \subpage osx_clang - * - \subpage linux_gcc - * - \subpage linux_icc + * - \subpage linux_all * * \section installation_from_binary From Binary * Pre-compiled releases are not currently provided, but they can be built from source using the instructions above. @@ -150,7 +149,7 @@ $ br -help * -# For "Compiler:" select "Microsoft Visual C++ Compiler 11.0 (amd64)" and click "OK" * -# From the Qt Creator "File" menu select "Open File or Project...". * -# Select "C:\openbr\CMakeLists.txt" then "Open". - * -# Browse to your prexisting build directory "C:\openbr\build-msvc2012" then select "Next". + * -# Browse to your pre-existing build directory "C:\openbr\build-msvc2012" then select "Next". * -# Clear any text in the "arguments" box then select "Run CMake" then "Finish". * -# You're all set! You can find more information on Qt Creator here if you need. * -# (Optional) Package OpenBR! @@ -229,7 +228,7 @@ $ br -help * -# For "Compiler:" select "MinGW (x86 64bit)" and click "OK" * -# From the Qt Creator "File" menu select "Open File or Project...". * -# Select "C:\openbr\CMakeLists.txt" then "Open". - * -# Browse to your prexisting build directory "C:\openbr\build-mingw64" then select "Next". + * -# Browse to your pre-existing build directory "C:\openbr\build-mingw64" then select "Next". * -# Clear any text in the "arguments" box then select "Run CMake" then "Finish". * -# You're all set! You can find more information on Qt Creator here if you need. * -# (Optional) Package OpenBR! @@ -278,8 +277,7 @@ $ br -help * \endcode * -# Build OpenBR! * \code - * $ cd openbr - * $ mkdir build + * $ mkdir build # from the OpenBR root directory * $ cd build * $ cmake -DCMAKE_PREFIX_PATH=~/Qt5.0.2/5.0.2/clang_64 -DCMAKE_BUILD_TYPE=Release .. * $ make -j4 @@ -292,7 +290,7 @@ $ br -help * \endcode * -# From the Qt Creator "File" menu select "Open File or Project...". * -# Select "openbr/CMakeLists.txt" then "Open". - * -# Browse to your prexisting build directory "openbr/build" then select "Continue". + * -# Browse to your pre-existing build directory "openbr/build" then select "Continue". * -# Select "Run CMake" then "Done". * -# You're all set! You can find more information on Qt Creator here if you need. * -# (Optional) Test OpenBR! @@ -305,7 +303,7 @@ $ br -help * -# (Optional) Package OpenBR! * \code * $ cd openbr/build - * $ cpack -G TGZ + * $ sudo cpack -G TGZ * \endcode * -# (Optional) Build OpenBR documentation! * -# Download Doxygen 1.8.2 @@ -329,42 +327,33 @@ $ br -help */ /*! - * \page linux_gcc Ubuntu 12.04 LTS - GCC 4.6.3 - x64 - * -# Install GCC 4.6.3. + * \page linux_all Ubuntu 13.04 - GCC 4.7.3 or ICC 13.1.1 - x64 + * -# Install GCC 4.7.3 * \code * $ sudo apt-get update * $ sudo apt-get install build-essential * \endcode - * -# Download CMake 2.8.10.2. + * -# (Optional) Assuming you meet the eligibility requirements and you want to use ICC instead of GCC, Download and Install Intel C++ Studio XE 2013. + * -# Install CMake 2.8.10.1 * \code - * $ cd ~/Downloads - * $ tar -xf cmake-2.8.10.2.tar.gz - * $ cd cmake-2.8.10.2 - * $ ./configure - * $ make -j4 - * $ sudo make install - * $ cd .. - * $ rm -r cmake-2.8.10.2 + * $ sudo apt-get install cmake cmake-curses-gui * \endcode - * -# Download OpenCV 2.4.4. + * -# Download OpenCV 2.4.5 * \code * $ cd ~/Downloads - * $ tar -xf OpenCV-2.4.4.tar.bz2 - * $ cd OpenCV-2.4.4 + * $ tar -xf opencv-2.4.5.tar.gz + * $ cd opencv-2.4.5 * $ mkdir build * $ cd build - * $ cmake -DBUILD_opencv_java=OFF -DBUILD_opencv_world=ON -DCMAKE_BUILD_TYPE=Release .. + * $ cmake -DCMAKE_BUILD_TYPE=Release .. * $ make -j4 * $ sudo make install * $ cd ../.. - * $ rm -r OpenCV-2.4.4 + * $ rm -rf opencv-2.4.5* * \endcode - * -# Download Qt 5.0.1. + * -# Install Qt 5.0.1 * \code - * $ cd ~/Downloads - * $ chmod +x qt-linux-opensource-5.0.1-x86_64-offline.run - * $ ./qt-linux-opensource-5.0.1-x86_64-offline.run - * $ rm qt-linux-opensource-5.0.1-x86_64-offline.run + * $ sudo apt-get install qt5-default libqt5svg5-dev qtcreator * \endcode * -# Create a GitHub account, follow their instructions for setting up Git. * \code @@ -375,94 +364,43 @@ $ br -help * \endcode * -# Build OpenBR! * \code - * $ cd openbr - * $ mkdir build + * $ mkdir build # from the OpenBR root directory * $ cd build - * $ cmake -DCMAKE_PREFIX_PATH=~/Qt5.0.1/5.0.1/gcc_64 -DCMAKE_BUILD_TYPE=Release .. + * $ cmake -DCMAKE_BUILD_TYPE=Release .. # GCC Only + * $ cmake -DCMAKE_C_COMPILER=/opt/intel/bin/icc -DCMAKE_CXX_COMPILER=/opt/intel/bin/icpc -DCMAKE_BUILD_TYPE=Release .. # ICC Only * $ make -j4 * $ sudo make install * \endcode * -# Hack OpenBR! * -# Open Qt Creator IDE * \code - * $ ~/Qt5.0.1/Tools/QtCreator/bin/qtcreator & + * $ qtcreator & * \endcode * -# From the Qt Creator "File" menu select "Open File or Project...". - * -# Select "~/openbr/CMakeLists.txt" then "Open". - * -# Browse to your prexisting build directory "~/openbr/build" then select "Next". + * -# Select "openbr/CMakeLists.txt" then "Open". + * -# Browse to your pre-existing build directory "openbr/build" then select "Next". * -# Select "Run CMake" then "Finish". - * -# You're all set! You can find more information on Qt Creator here if you need. - * -# (Optional) Package OpenBR! - * \code - * $ cd openbr/build - * $ make package - * \endcode - */ - -/*! - * \page linux_icc Ubuntu 12.04 LTS - Intel C++ Studio XE 2013 - x64 - * -# Assuming you meet the eligibility requirements, Download Intel C++ Studio XE 2013 and install. - * -# Download CMake 2.8.10.2. - * \code - * $ cd ~/Downloads - * $ tar -xf cmake-2.8.10.2.tar.gz - * $ cd cmake-2.8.10.2 - * $ ./configure - * $ make -j4 - * $ sudo make install - * $ cd .. - * $ rm -r cmake-2.8.10.2 - * \endcode - * -# Download OpenCV 2.4.4. - * \code - * $ cd ~/Downloads - * $ tar -xf OpenCV-2.4.4.tar.bz2 - * $ cd OpenCV-2.4.4 - * $ mkdir build - * $ cd build - * $ cmake cmake -DBUILD_opencv_java=OFF -DBUILD_opencv_world=ON -DCMAKE_BUILD_TYPE=Release .. - * $ make -j4 - * $ sudo make install - * $ cd ../.. - * $ rm -r OpenCV-2.4.4 - * \endcode - * -# Download Qt 5.0.1. - * \code - * $ cd ~/Downloads - * $ chmod +x qt-linux-opensource-5.0.1-x86_64-offline.run - * $ ./qt-linux-opensource-5.0.1-x86_64-offline.run - * $ rm qt-linux-opensource-5.0.1-x86_64-offline.run - * \endcode - * -# Create a GitHub account, follow their instructions for setting up Git. + * -# You're all set! You can find more information on Qt Creator here if you need. + * -# (Optional) Test OpenBR! * \code - * $ git clone https://github.com/biometrics/openbr.git - * $ cd openbr - * $ git submodule init - * $ git submodule update + * $ cd openbr/scripts + * $ ./downloadDatasets.sh + * $ cd ../build + * $ make test * \endcode - * -# Build OpenBR! + * -# (Optional) Package OpenBR! * \code - * $ cd openbr - * $ mkdir build-icc - * $ cd build-icc - * $ cmake -DCMAKE_C_COMPILER=/opt/intel/bin/icc -DCMAKE_CXX_COMPILER=/opt/intel/bin/icpc -DCMAKE_PREFIX_PATH=~/Qt5.0.1/5.0.1/gcc_64 -DCMAKE_BUILD_TYPE=Release .. - * $ make -j4 - * $ sudo make install + * $ cd openbr/build + * $ sudo cpack -G TGZ * \endcode - * -# Hack OpenBR! - * -# Open Qt Creator IDE - * \code - * $ ~/Qt5.0.1/Tools/QtCreator/bin/qtcreator & - * \endcode - * -# From the Qt Creator "File" menu select "Open File or Project...". - * -# Select "~/openbr/CMakeLists.txt" then "Open". - * -# Browse to your prexisting build directory "~/openbr/build" then select "Next". - * -# Select "Run CMake" then "Finish". - * -# You're all set! You can find more information on Qt Creator here if you need. - * -# (Optional) Package OpenBR! + * -# (Optional) Build OpenBR documentation! * \code + * $ sudo apt-get install doxygen * $ cd openbr/build - * $ make package + * $ cmake -DBR_BUILD_DOCUMENTATION=ON .. + * $ make -j4 + * $ sudo apt-get install libgnome2-bin + * $ gnome-open html/index.html * \endcode */