From 9608aef3ff7fda70eaf9afec257c5693513c7dde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joan=20Vallv=C3=A9=20Navarro?= <jvallve@iri.upc.edu> Date: Tue, 19 Oct 2021 10:54:05 +0200 Subject: [PATCH] Update README.md code like --- README.md | 71 +++++++++++++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 31689b1..4686894 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,33 +60,33 @@ 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 +- `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 .." +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 +- `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 +- 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/ @@ -99,28 +98,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 -- GitLab