You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: reorganize and improve README installation instructions
- Moved quick start dependencies/install details under a new "Custom install" section.
- Added clarification and refined installer script usage with examples and options.
- Removed redundant quick start overview to streamline content.
The first script installs all Libpointmatcher dependencies. The second script installs Libpointmatcher.
129
+
The `--build-system-CI-install` flag tell the installer to colocate the build and the repository.
130
+
If you want to install to a different location, instead use the `--install-path </dir/abs/path/>` flag.
131
+
Use the `--help` flag for more options.
132
132
133
+
### Custom install
134
+
Although we suggest to use the [tutorials](doc/Compilation.md), here is a quick version of it:
133
135
134
-
### Compilation & Installation
135
-
136
-
For beginner users unfamiliar with compiling and installing a library in Linux, go [here](doc/CompilationUbuntu.md) for detailed instructions on compiling libpointmatcher from the source code.
136
+
The library has a light dependency list:
137
137
138
-
For conveniences, you can use the provided installer script for ubuntu
139
-
```shell
140
-
bash libpointmatcher_dependencies_installer.bash
138
+
*[Eigen] version 3, a modern C++ matrix and linear-algebra library,
139
+
*[boost] version 1.48 and up, portable C++ source libraries,
140
+
*[libnabo] version 1.0.7, a fast K Nearest Neighbour library for low-dimensional spaces,
141
141
142
-
# Use the --help flag to see the list of optional flag
* Windows ([see how](/doc/CompilationWindows.md) - partially supported)
145
146
146
147
If you are comfortable with Linux and CMake and have already installed the prerequisites above, the following commands should install libpointmatcher on your system.
147
148
@@ -153,7 +154,7 @@ sudo make install
153
154
```
154
155
155
156
156
-
###Testing
157
+
## Testing
157
158
158
159
Libpointmatcher ships with a version of the Google testing framework [GTest](https://github.com/google/googletest). Unit tests are located in the `utest/` directory and are compiled with libpointmatcher (CMake variable `BUILD_TESTS` must be set to `TRUE` before compiling). To run the tests and make sure that your compiled version is working correctly, run the test executable in your build directory:
159
160
@@ -162,7 +163,7 @@ cd build
162
163
utest/utest --path ../examples/data/
163
164
```
164
165
165
-
###Linking to external projects.
166
+
## Linking to external projects.
166
167
167
168
We mainly develop for __cmake projects__ and we provide example files under [`examples/demo_cmake/`](https://github.com/norlab-ulaval/libpointmatcher/tree/master/examples/demo_cmake) to help you in your own project. We also provide a __QT Creator__ example in [`examples/demo_QT/`](https://github.com/norlab-ulaval/libpointmatcher/tree/master/examples/demo_Qt), which manually lists all the dependencies in the file [`demo.pro`](https://github.com/norlab-ulaval/libpointmatcher/blob/master/examples/demo_Qt/demo.pro). You would need to ajust those paths to point at the appropriate locations on your system. For a more detailed procedure, check the [Linking Projects to libpointmatcher](doc/LinkingProjects.md) section.
0 commit comments