diff --git a/README.md b/README.md index 31689b12fa815c053160b3369d65ebf6ca7f6670..b217408ae3ac7ebca06a3707275624d20559e02e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # FALKOLib - Fast Adaptive Laser Keypoint Orientation-invariant #### Copyright (C) 2016 Fabjan Kallasi and Dario Lodi Rizzini. @@ -61,34 +60,38 @@ which has been included in folder EXTERNAL. HOW TO COMPILE ------------------------------------------------- -Let ${falkolib_ROOT} be the install directory of your local copy +Let `${falkolib_ROOT}` be the install directory of your local copy of library falkolib. The following standard commands are required to compile it: -- cd ${falkolib_ROOT} -- mkdir build -- cd build -- cmake .. -- make +```sh +cd ${falkolib_ROOT} +mkdir build +cd build +cmake .. +make +``` You can also install the library into a system directory. To change the install directory you must set cmake environment -variable ${CMAKE_INSTALL_PREFIX} (e.g. using command "ccmake .." -before calling "cmake .."). +variable `${CMAKE_INSTALL_PREFIX}` (e.g. using command `ccmake ..` +before calling `cmake ..`). Its default value on UNIX-like/Linux systems is "/usr/local". After compiling library falkolib, run the command: -- sudo make install +```sh +sudo make install +``` -The command "sudo" is required only if ${CMAKE_INSTALL_PREFIX} +The command `sudo` is required only if `${CMAKE_INSTALL_PREFIX}` is a system diretory managed by administrator user root. Such command copies: -- header files of ${falkolib_ROOT}/include/falkolib to - ${CMAKE_INSTALL_PREFIX}/include/falkolib/ -- library files ${falkolib_ROOT}/lib/libfalkolib.a to - ${CMAKE_INSTALL_PREFIX}/lib/ -- cmake script ${falkolib_ROOT}/cmake_modules/falkolibConfig.cmake to - ${CMAKE_INSTALL_PREFIX}/share/falkolib/ +- header files of `${falkolib_ROOT}/include/falkolib` to + `${CMAKE_INSTALL_PREFIX}/include/falkolib/` +- library files `${falkolib_ROOT}/lib/libfalkolib.a` to + `${CMAKE_INSTALL_PREFIX}/lib/` +- cmake script `${falkolib_ROOT}/cmake_modules/falkolibConfig.cmake` to + `${CMAKE_INSTALL_PREFIX}/share/falkolib/` HOW TO USE LIBRARY falkolib IN YOUR PROJECT @@ -99,28 +102,28 @@ then it is straighforward to use it in your projects. You needs to add the following lines to your project as in this example: -> CMAKE_MINIMUM_REQUIRED(VERSION 2.8) -> PROJECT(foobar) -> -> find_package(falkolib REQUIRED) -> message(STATUS "falkolib_FOUND ${falkolib_FOUND}") -> message(STATUS "falkolib_INCLUDE_DIRS ${falkolib_INCLUDE_DIRS}") -> message(STATUS "falkolib_LIBRARY_DIRS ${falkolib_LIBRARY_DIRS}") -> message(STATUS "falkolib_LIBRARIES ${falkolib_LIBRARIES}") -> -> if(${falkolib_FOUND}) -> include_directories(${falkolib_INCLUDE_DIRS}) -> link_directories(${falkolib_LIBRARY_DIRS}) -> endif() -> -> add_executable(foobar foobar.cpp) -> target_link_libraries(foobar ${falkolib_LIBRARIES}) +```cmake +CMAKE_MINIMUM_REQUIRED(VERSION 2.8) +PROJECT(foobar) -The above example uses the variables defined in falkolibConfig.cmake: +find_package(falkolib REQUIRED) +message(STATUS "falkolib_FOUND ${falkolib_FOUND}") +message(STATUS "falkolib_INCLUDE_DIRS ${falkolib_INCLUDE_DIRS}") +message(STATUS "falkolib_LIBRARY_DIRS ${falkolib_LIBRARY_DIRS}") +message(STATUS "falkolib_LIBRARIES ${falkolib_LIBRARIES}") + +if(${falkolib_FOUND}) + include_directories(${falkolib_INCLUDE_DIRS}) + link_directories(${falkolib_LIBRARY_DIRS}) +endif() -- falkolib_FOUND - system has falkolib module -- falkolib_INCLUDE_DIRS - the falkolib include directories -- falkolib_LIBRARY_DIRS - the falkolib library directories -- falkolib_LIBRARIES - link these to use falkolib +add_executable(foobar foobar.cpp) +target_link_libraries(foobar ${falkolib_LIBRARIES}) +``` +The above example uses the variables defined in `falkolibConfig.cmake`: +- `falkolib_FOUND` - system has falkolib module +- `falkolib_INCLUDE_DIRS` - the falkolib include directories +- `falkolib_LIBRARY_DIRS` - the falkolib library directories +- `falkolib_LIBRARIES` - link these to use falkolib diff --git a/cmake_modules/FindEigen3.cmake b/cmake_modules/FindEigen3.cmake index 8c2a734c3d3fe5f73fd3d87557037522de13e964..55e14017a80faa994edb544ac65cd8e371b55386 100644 --- a/cmake_modules/FindEigen3.cmake +++ b/cmake_modules/FindEigen3.cmake @@ -53,13 +53,13 @@ macro(_eigen3_check_version) endif(NOT EIGEN3_VERSION_OK) endmacro(_eigen3_check_version) -if (EIGEN3_INCLUDE_DIR) - - # in cache already - _eigen3_check_version() - set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) - -else (EIGEN3_INCLUDE_DIR) +#if (EIGEN3_INCLUDE_DIR) +# +# # in cache already +# _eigen3_check_version() +# set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) +# +#else (EIGEN3_INCLUDE_DIR) # specific additional paths for some OS if (WIN32) @@ -83,5 +83,5 @@ else (EIGEN3_INCLUDE_DIR) mark_as_advanced(EIGEN3_INCLUDE_DIR) -endif(EIGEN3_INCLUDE_DIR) +#endif(EIGEN3_INCLUDE_DIR)