Skip to content

Commit

Permalink
[doc] updated doc on how to use AV as 3rd party
Browse files Browse the repository at this point in the history
  • Loading branch information
simogasp authored and fabiencastan committed Jul 25, 2019
1 parent 8e7094d commit e9d03b3
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,25 +350,31 @@ Using AliceVision as a third party library dependency in cmake
--------------------------------------------------------------

AliceVision can be used as a third party once it have been installed.
Because it can use its own Ceres version, it is better to install it locally and not in system files.
So please consider using the `CMAKE_INSTALL_PREFIX` cmake variable to specify a local installation directory.

Consider using the `CMAKE_INSTALL_PREFIX` cmake variable to specify a local installation directory.
Here the syntax to add the variable to the cmake command line (use absolute path), e.g.:
```bash
-DCMAKE_INSTALL_PREFIX="/home/user/dev/AliceVision_install"
```

Perform `make` and `make install`

Then you will be able to use AliceVision as an external library in your `CMakeLists.txt`:
Then you will be able to use AliceVision as an external library in your `CMakeLists.txt` using
the modern CMake approach as imported target. For example, if your target `main` depends on the
aliceVision module `aliceVision_sfmDataIO`:

```cmake
find_package(AliceVision REQUIRED)
include_directories(${ALICEVISION_INCLUDE_DIRS})
find_package(aliceVision CONFIG REQUIRED)
message(STATUS "Found AliceVision : ${aliceVision_FOUND}")
message(STATUS "Found AliceVision version: ${aliceVision_VERSION}")
add_executable(main main.cpp)
target_link_libraries(main ${ALICEVISION_LIBRARIES})
target_link_libraries(main PUBLIC aliceVision_sfmDataIO)
```

Specify to CMake where AliceVision is installed by using the `AliceVision_DIR` cmake variable: `-DAliceVision_DIR:STRING="YourInstallPath"/share/aliceVision/cmake`
In general, you need to specify the list of the aliceVision modules that your library or executable
depends on.

Specify to CMake where AliceVision is installed by using the `AliceVision_DIR` cmake variable: `-DAliceVision_DIR:PATH="YourInstallPath"/share/aliceVision/cmake`
or by simply adding the installation path to your `CMAKE_PREFIX_PATH`, i.e. `-DCMAKE_PREFIX_PATH:PATH="YourInstallPath"`.


### Docker image
Expand Down

0 comments on commit e9d03b3

Please sign in to comment.