From e08df81606e3b8774858a6283d0df1563675fb6d Mon Sep 17 00:00:00 2001 From: boxanm Date: Sat, 13 Jul 2024 14:34:21 -0400 Subject: [PATCH 1/2] Replace ethz-asl by norlab-ulaval --- doc/ApplicationsAndPub.md | 16 ++++++++-------- doc/Compilation.md | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/ApplicationsAndPub.md b/doc/ApplicationsAndPub.md index 9506b240..3ccb831e 100644 --- a/doc/ApplicationsAndPub.md +++ b/doc/ApplicationsAndPub.md @@ -21,7 +21,7 @@ Click on the image to play. + Sensor: Velodyne HDL-32E + Application: 3D mapping and localization - + - __NIFTi: railyard mapping__ @@ -30,7 +30,7 @@ Click on the image to play. + Sensor: Sick LMS-151 + Application: 3D mapping and localization - @@ -40,7 +40,7 @@ Click on the image to play. + Sensor: Sick LMS-151 + Application: 3D mapping and localization - @@ -52,7 +52,7 @@ Click on the image to play. - Sensor: Velodyne HDL-32E - Application: Navigation - @@ -64,7 +64,7 @@ Click on the image to play. + Sensor: Velodyne HDL-32E + Application: 3D mapping and localization - @@ -74,7 +74,7 @@ Click on the image to play. + Sensor: Velodyne HDL-32E + Application: 3D mapping and localization - @@ -84,7 +84,7 @@ Click on the image to play. + Sensor: Kinect + Application: 3D model reconstruction - @@ -94,7 +94,7 @@ Click on the image to play. + Sensor: Kinect + Application: 3D mapping and localization - diff --git a/doc/Compilation.md b/doc/Compilation.md index 4849e650..04b5695c 100644 --- a/doc/Compilation.md +++ b/doc/Compilation.md @@ -316,13 +316,13 @@ First, you need to clone the source repository into a local directory. As an exa === "Ubuntu" ```bash cd ~/Libraries/ - git clone git://github.com/ethz-asl/libpointmatcher.git + git clone git://github.com/norlab-ulaval/libpointmatcher.git cd libpointmatcher ``` === "MacOS" ```bash cd ~/Libraries/ - git clone git://github.com/ethz-asl/libpointmatcher.git + git clone git://github.com/norlab-ulaval/libpointmatcher.git cd libpointmatcher ``` === "Windows" From 0b1a191b83f33cc880ceb4b8c52a2ee30808e421 Mon Sep 17 00:00:00 2001 From: boxanm Date: Sat, 13 Jul 2024 14:42:01 -0400 Subject: [PATCH 2/2] Fix Windows content tab in Compilation.md --- doc/Compilation.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/Compilation.md b/doc/Compilation.md index 04b5695c..ecce5225 100644 --- a/doc/Compilation.md +++ b/doc/Compilation.md @@ -390,7 +390,7 @@ You will also need LaTeX for the equations rendering : After you have installed Doxygen and LaTeX, you can enable the documentation by setting the CMake variable `GENERATE_API_DOC` to `TRUE`. This can be achieved through CMake-GUI or by the command line in your `build` directory: ```bash - cmake -D GENERATE_API_DOC=TRUE ${SRC_DIR} +cmake -D GENERATE_API_DOC=TRUE ${SRC_DIR} ``` Compiling libpointmatcher will generate the documentation, which you can simply open the `/usr/local/share/doc/libpointmatcher/api/html/index.html` file to view the API documentation in a browser. @@ -407,9 +407,10 @@ If you want to verify that the version of libpointmatcher you have compiled is s ```bash cmake -D BUILD_TESTS=TRUE ${SRC_DIR} ``` -=== "Windows +=== "Windows" Set the CMake variable `BUILD_TESTS` to `TRUE` + Then, once the compilation process is completed, the unit tests can be run with the following command line: === "Ubuntu" @@ -420,7 +421,7 @@ Then, once the compilation process is completed, the unit tests can be run with ```bash utest/utest --path ${SRC_DIR}/examples/data/ ``` -=== "Windows +=== "Windows" From build directory ```powershell utest/utest --path ../examples/data/ @@ -434,18 +435,18 @@ Now, to compile libpointmatcher into the `/build` directory, run the following c ```bash make -j N ``` -*Note:* It is highly recommended to add the `-j N` optional argument to the `make` command in order to speed up the compilation process. Replace `N` by the number of parallel jobs you want to compile at the same time. + *Note:* It is highly recommended to add the `-j N` optional argument to the `make` command in order to speed up the compilation process. Replace `N` by the number of parallel jobs you want to compile at the same time. === "MacOS" ```bash make -j N ``` -*Note:* It is highly recommended to add the `-j N` optional argument to the `make` command in order to speed up the compilation process. Replace `N` by the number of parallel jobs you want to compile at the same time. + *Note:* It is highly recommended to add the `-j N` optional argument to the `make` command in order to speed up the compilation process. Replace `N` by the number of parallel jobs you want to compile at the same time. -=== "Windows +=== "Windows" Following the previous configuration in CMake GUI: - 1. Click on the button Configure, Generate and then Open Project - Visual Studio will open up + + 1. Click on the button Configure, Generate and then Open Project. Visual Studio will open up 2. Put your "Solution Configuration" in `Release` mode 3. Build the `BUILD` project @@ -461,8 +462,9 @@ Finally, to install libpointmatcher on your system, run the following command: ```bash sudo make install ``` -=== "Windows +=== "Windows" Following the previous configuration in CMake GUI: + 1. Build the `INSTALL` project > We have to install the library and not only build it, because otherwise all CMake files won't be able to be found by programs using libpointmatcher 2. Set `libpointmatcher_DIR` environment variable to `C:\dev\libpointmatcher\build\install\share\libpointmatcher\cmake` @@ -484,9 +486,8 @@ Some dependencies changed, and we don't keep track of all combinations possible. chmod +x ./utest/listVersionsMacOS.sh ./utest/listVersionsMacOS.sh ``` -=== "Windows - ```TODO - chmod +x ./utest/listVersionsWindows.sh - ./utest/listVersionsWindows.sh +=== "Windows" + ``` + TODO ``` \ No newline at end of file