diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f8ec3844b612a06d5be5942f570f00af0178eba7 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +firewire_camera library {#mainpage} +============ + +## Description + +Driver for firewire cameras. + +## Dependencies + +This package requires of the following system libraries and packages + +* [cmake](https://www.cmake.org "CMake's Homepage"), a cross-platform build system. +* libdc1394]: sudo apt install libdc1394-22-dev + +This package also requires of the following IRI libraries: + +* [iriutils](https://gitlab.iri.upc.edu/labrobotica/algorithms/iriutils "iriutils gitlab page"), a set of basic tools. + +## Compilation and installation + +Download this repository and create a build folder inside: + +``` mkdir build ``` + +Inside the build folder execute the following commands: + +``` cmake .. ``` + +The default build mode is DEBUG. That is, objects and executables include debug information. + +The RELEASE build mode optimizes for speed. To build in this mode execute instead +``` cmake .. -DCMAKE_BUILD_TYPE=RELEASE ``` + +The release mode will be kept until next time cmake is executed. + +``` make ``` + +In case no errors are reported, the generated libraries (if any) will be located at the +_lib_ folder and the executables (if any) will be located at the _bin_ folder. + +In order to be able to use the library, it it necessary to copy it into the system. +To do that, execute + +``` make install ``` + +as root and the shared libraries will be copied to */usr/local/lib/iridrivers* directory +and the header files will be copied to */usr/local/include/iridrivers* dierctory. At +this point, the library may be used by any user. + +To remove the library from the system, exceute + +``` make uninstall ``` + +as root, and all the associated files will be removed from the system. + +To generate the documentation execute the following command: + +``` make doc ``` + +## How to use it + +To use this library in an other library or application, in the CMakeLists.txt file, first it is necessary to locate if the library has been installed or not using the following command + +``` FIND_PACKAGE(<library name>) ``` + +In the case that the package is present, it is necessary to add the header files directory to the include directory path by using + +``` INCLUDE_DIRECTORIES(${<library name>_INCLUDE_DIR}) ``` + +and it is also necessary to link with the desired libraries by using the following command + +``` TARGET_LINK_LIBRARIES(<executable name> ${<library name>_LIBRARY}) ``` + +## Disclaimer + +Copyright (C) 2009-2018 Institut de Robòtica i Informà tica Industrial, CSIC-UPC. +Mantainer IRI labrobotics (labrobotica@iri.upc.edu) + +This package is distributed in the hope that it will be useful, but without any warranty. It is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. should the program prove defective, the GMR group does not assume the cost of any necessary servicing, repair or correction. + +In no event unless required by applicable law the author will be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if the author has been advised of the possibility of such damages. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see <http://www.gnu.org/licenses/> diff --git a/ReadMe.txt b/ReadMe.txt deleted file mode 100644 index a531af509ef8f0ae969d9c9edf6cb78cc25222a7..0000000000000000000000000000000000000000 --- a/ReadMe.txt +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (C) 2009-2010 Institut de Robòtica i Informà tica Industrial, CSIC-UPC. -Author shernand (shernand@iri.upc.edu) -All rights reserved. - -This file is part of firewire camera driver library -firewire camera driver library is free software: you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation, either version 3 of the License, or -at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public License -along with this program. If not, see <http://www.gnu.org/licenses/> - - diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 5cc0a6461b8ee1751d199b6b0cb1e9b0f9bebd16..28eed989be75e15a3538ccd838b5a947e223caa9 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -4,7 +4,7 @@ SET(sources firewirecamera.cpp firewireserver.cpp firewireexceptions.cpp ptg_cam SET(headers firewirecamera.h firewireserver.h firewireexceptions.h ptg_camera.h bumblebee.h ladybug.h) #find the cv support and set HAVE_OPENCV_H for the conditional compilation -FIND_PACKAGE(OpenCV 2.4) +FIND_PACKAGE(OpenCV) if (OpenCV_FOUND) if (${OpenCV_VERSION_MAJOR} GREATER 1)