Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #579

Merged
merged 2 commits into from
Jul 13, 2024
Merged

Update docs #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e08df81
Replace ethz-asl by norlab-ulaval
boxanm Jul 13, 2024
0b1a191
Fix Windows content tab in Compilation.md
boxanm Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/ApplicationsAndPub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Click on the image to play.
+ Sensor: Velodyne HDL-32E
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=cMgLyLpnsoU" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/cMgLyLpnsoU.jpg" width="240" height="180"/>
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/cMgLyLpnsoU.jpg" width="240" height="180"/>
</a>

- __NIFTi: railyard mapping__
Expand All @@ -30,7 +30,7 @@ Click on the image to play.
+ Sensor: Sick LMS-151
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=ygIvzWVfPYk" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/ygIvzWVfPYk.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/ygIvzWVfPYk.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -40,7 +40,7 @@ Click on the image to play.
+ Sensor: Sick LMS-151
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=lP5Mj-TGaiw" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/lP5Mj-TGaiw.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/lP5Mj-TGaiw.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -52,7 +52,7 @@ Click on the image to play.
- Sensor: Velodyne HDL-32E
- Application: Navigation
<a href="https://www.youtube.com/watch?v=UCCAUf64tD0" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/UCCAUf64tD0.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/UCCAUf64tD0.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -64,7 +64,7 @@ Click on the image to play.
+ Sensor: Velodyne HDL-32E
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=M5Y99o7um88" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/M5Y99o7um88.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/M5Y99o7um88.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -74,7 +74,7 @@ Click on the image to play.
+ Sensor: Velodyne HDL-32E
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=g8l-Xq4qYeE" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/g8l-Xq4qYeE.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/g8l-Xq4qYeE.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -84,7 +84,7 @@ Click on the image to play.
+ Sensor: Kinect
+ Application: 3D model reconstruction
<a href="https://www.youtube.com/watch?v=rIZud3F5IJw" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/rIZud3F5IJw.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/rIZud3F5IJw.jpg"
width="240" height="180" border="10" />
</a>

Expand All @@ -94,7 +94,7 @@ Click on the image to play.
+ Sensor: Kinect
+ Application: 3D mapping and localization
<a href="https://www.youtube.com/watch?v=McxpJGOZTPs" target="_blank">
<img src="https://raw.githubusercontent.com/ethz-asl/libpointmatcher/master/doc/images/youtubeCovers/McxpJGOZTPs.jpg"
<img src="https://raw.githubusercontent.com/norlab-ulaval/libpointmatcher/master/doc/images/youtubeCovers/McxpJGOZTPs.jpg"
width="240" height="180" border="10" />
</a>
</div>
Expand Down
31 changes: 16 additions & 15 deletions doc/Compilation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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.
Expand All @@ -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"
Expand All @@ -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/
Expand All @@ -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

Expand All @@ -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`
Expand All @@ -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
```

Loading