From 6e409cf603a5360221404cbf3f3ae29e2a758ded Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joan=20Vallv=C3=A9=20Navarro?= <jvallve@iri.upc.edu> Date: Sun, 22 Nov 2020 18:22:59 +0100 Subject: [PATCH] Update README.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3d6ae3..0e8f786 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -A C++ Toolbox with utilities for 2D laser scan processing, made at IRI (www.iri.upc.edu) +A C++ Toolbox with utilities for 2D laser scan processing, made at IRI (www.iri.upc.edu). + +# Installation + +Clone the repository in your chosen directory. In a terminal: + +``` +cd <your/path> +git clone <repo-link> +``` + +Create a directory to build all the source files: +``` +$ mkdir build +$ cd build +``` + +Compile the source files: + +``` +$ cmake .. +$ make +``` + +## Optional dependencies + +**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: +``` +cd <your/path> +git clone https://github.com/AndreaCensi/csm.git +cd csm +cmake . +make +sudo make install +``` + +CSM depends on GSL that you probably have installed already. To install it: +``` +sudo apt install libgsl-dev +``` \ No newline at end of file -- GitLab