diff --git a/README.md b/README.md index 28b4a1778bb591428568b0d8ef83c443d1376097..31689b12fa815c053160b3369d65ebf6ca7f6670 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -* FALKOLib - Fast Adaptive Laser Keypoint Orientation-invariant -* Copyright (C) 2016 Fabjan Kallasi and Dario Lodi Rizzini. +# FALKOLib - Fast Adaptive Laser Keypoint Orientation-invariant +#### Copyright (C) 2016 Fabjan Kallasi and Dario Lodi Rizzini. OVERVIEW @@ -41,7 +41,7 @@ Fast Keypoint Features from Laser Scanner for Robot Localization and Mapping. IEEE Robotics and Automation Letters (RA-L), 1(1):176-183, jan 2016. DOI 10.1109/LRA.2016.2517210 -or the most relevant publication associated by visiting: +or the most relevant associated publications by visiting: http://rimlab.ce.unipr.it/FALKOLib.html @@ -50,8 +50,8 @@ DEPENDENCIES The software depends on the following external libraries -Boost >= 1.36 (submodule lexical_cast) -Eigen 3.0 +- Boost >= 1.36 (submodule lexical_cast) +- Eigen 3.0 The library also requires the third party library mcqd developed by Janez Konc (see http://www.sicmm.org/konc/), @@ -65,11 +65,11 @@ 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 +- 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 @@ -78,7 +78,7 @@ before calling "cmake .."). Its default value on UNIX-like/Linux systems is "/usr/local". After compiling library falkolib, run the command: - sudo make install +- sudo make install The command "sudo" is required only if ${CMAKE_INSTALL_PREFIX} is a system diretory managed by administrator user root. @@ -99,28 +99,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_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}) 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 +- 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