Skip to content

Commit

Permalink
Update documentation with reference to ROBOTOLOGY_USES_PCL_AND_VTK op…
Browse files Browse the repository at this point in the history
…tion (#56)
  • Loading branch information
traversaro authored Sep 21, 2022
1 parent ba01bf1 commit f694f34
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
This repository contains the scripts to generate the Windows binaries for the dependencies of the
[robotology-superbuild](https://github.com/robotology/robotology-superbuild) using [vcpkg](https://github.com/Microsoft/vcpkg).

For each release, the scripts in this repo generate two binaries:
* `vcpkg-robotology.zip`: contains the pre-compiled vcpkg dependencies of the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), except the Gazebo dependency required by the ROBOTOLOGY_USES_GAZEBO option
* `vcpkg-robotology-with-gazebo.zip`: contains the pre-compiled vcpkg dependencies of the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), **including** the Gazebo dependency required by the ROBOTOLOGY_USES_GAZEBO option
For each release, the scripts in this repo generate two archives:
* `vcpkg-robotology.zip`: contains the pre-compiled vcpkg dependencies of the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), except the dependencies required by the `ROBOTOLOGY_USES_GAZEBO` and `ROBOTOLOGY_USES_PCL_AND_VTK` options.
* `vcpkg-robotology-with-gazebo.zip`: contains the pre-compiled vcpkg dependencies of the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), **including** the Gazebo, PCL and VTK dependencies required by the `ROBOTOLOGY_USES_GAZEBO` and `ROBOTOLOGY_USES_PCL_AND_VTK` options.

The binaries are generated by installing vcpkg and any additional dependency in `C:/robotology`, and compressing the `C:/robotology` directory in a `.zip` archive.

Expand Down Expand Up @@ -82,3 +82,5 @@ To use the script in a GitHub Action script, you can use the following snippet:

You can then specify the `CMAKE_TOOLCHAIN_FILE` for the CMake projects that you want that use the installed dependencies, or execute the enviroment variables
setup scripts.

If you want to use `vcpkg-robotology-with-gazebo.zip`, replace `vcpkg-robotology.zip` with `vcpkg-robotology-with-gazebo.zip`.

0 comments on commit f694f34

Please sign in to comment.