Skip to content
Snippets Groups Projects
Commit d1ed6e84 authored by Joan Vallvé Navarro's avatar Joan Vallvé Navarro
Browse files

Update README.md

parent 9941d4fc
No related branches found
No related tags found
1 merge request!4Resolve "Implementation of Falko lib"
...@@ -4,22 +4,22 @@ A C++ Toolbox with utilities for 2D laser scan processing, made at IRI (www.iri. ...@@ -4,22 +4,22 @@ A C++ Toolbox with utilities for 2D laser scan processing, made at IRI (www.iri.
Clone the repository in your chosen directory. In a terminal: Clone the repository in your chosen directory. In a terminal:
``` ```sh
cd <your/path> cd <your/path>
git clone <repo-link> git clone <repo-link>
``` ```
Create a directory to build all the source files: Create a directory to build all the source files:
``` ```sh
$ mkdir build mkdir build
$ cd build cd build
``` ```
Compile the source files: Compile the source files:
``` ```sh
$ cmake .. cmake ..
$ make make
``` ```
## Optional dependencies ## Optional dependencies
...@@ -27,7 +27,7 @@ $ make ...@@ -27,7 +27,7 @@ $ make
**Canonical Scan Matching - CSM** **Canonical Scan Matching - CSM**
To enable the compilation of iterative closest point algorithms, [CSM](https://github.com/AndreaCensi/csm) should be installed. Clone, compile and install: To enable the compilation of iterative closest point algorithms, [CSM](https://github.com/AndreaCensi/csm) should be installed. Clone, compile and install:
``` ```sh
cd <your/path> cd <your/path>
git clone https://github.com/AndreaCensi/csm.git git clone https://github.com/AndreaCensi/csm.git
cd csm cd csm
...@@ -37,46 +37,27 @@ sudo make install ...@@ -37,46 +37,27 @@ sudo make install
``` ```
CSM depends on GSL that you probably have installed already. To install it: CSM depends on GSL that you probably have installed already. To install it:
``` ```sh
sudo apt install libgsl-dev sudo apt install libgsl-dev
``` ```
**FALKO Library - falkolib** **FALKO Library - falkolib**
To enbale scan matching for loop closure purposes. The library is added as submodule in the deps folder. In order to initialize the submodule use the following commands: Loop closure search is implemented using FALKO Library. In order to download, compile and install it:
``` ```sh
cd <your/path> cd <your/path>
git submodule init git clone https://gitlab.iri.upc.edu/mobile_robotics/falkolib.git
git submodule update cd falkolib
```
In order to compile and install the repository:
```
cd <your/path>
cd deps/openslam_falkolib/
mkdir build mkdir build
cd build cd build
cmake .. cmake ..
make make
sudo make install
``` ```
You can also install the library into a system directory.
To change the install directory you must set cmake environment 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 .."). before calling `cmake ..`).
Its default value on UNIX-like/Linux systems is "/usr/local". Its default value on UNIX-like/Linux systems is "/usr/local".
After compiling library falkolib, run the command: The `sudo` is required only if `${CMAKE_INSTALL_PREFIX}`
```
sudo make install
```
The command "sudo" is required only if ${CMAKE_INSTALL_PREFIX}
is a system diretory managed by administrator user root. 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/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment