diff --git a/doc/cmake-options.md b/doc/cmake-options.md index 5fb580534..ec23984c6 100644 --- a/doc/cmake-options.md +++ b/doc/cmake-options.md @@ -63,7 +63,7 @@ The dependencies CMake options specify if the packages dependending on something | CMake Option | Description | Default Value | Dependency-specific documentation | |:------------:|:-----------:|:-------------:|:---------------------------------:| | `ROBOTOLOGY_USES_GAZEBO` | Include software and plugins that depend on the [Gazebo Classic simulator](https://classic.gazebosim.org/). | `ON` | [Documentation on Gazebo Classic dependency.](#gazebo-classic-simulator) | -| `ROBOTOLOGY_USES_GZ_SIM` | Include software and plugins that depend on the [Modern Gazebo (gz-sim) simulator](http://gazebosim.org/). | `OFF` | [Documentation on Modern Gazebo (gz-sim) dependency.](#modern-gazebo-simulator) | +| `ROBOTOLOGY_USES_GZ` | Include software and plugins that depend on the [Modern Gazebo (gz-sim) simulator](http://gazebosim.org/). | `OFF` | [Documentation on Modern Gazebo (gz-sim) dependency.](#modern-gazebo-simulator) | | `ROBOTOLOGY_USES_MUJOCO` | Include software and plugins that depend on the [MuJoCo simulator](https://mujoco.org/). | `ON` | [Documentation on MuJoCo dependency.](#mujoco) | | `ROBOTOLOGY_USES_PCL_AND_VTK` | Include software and plugins that depend on the [PCL](https://pointclouds.org/) or [VTK](https://vtk.org/). | `OFF` | [Documentation on PCL and VTK dependency.](#pcl_and_vtk) | | `ROBOTOLOGY_USES_IGNITION` | Include software that depends on [Ignition](ignitionrobotics.org/). | `OFF` | [Documentation on Ignition Gazebo dependency.](#ignition) | @@ -91,7 +91,7 @@ Not all options are supported on all platforms. The following table provides a r | `ROBOTOLOGY_ENABLE_EVENT_DRIVEN` | ✔️ | ❌ | ✔️ | ❌ | ❌ | | `ROBOTOLOGY_ENABLE_GRASPING` | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | `ROBOTOLOGY_USES_GAZEBO` | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | -| `ROBOTOLOGY_USES_GZ_SIM`[3!](#f3) | ✔️ | ❌ | ✔️ | ✔️ | ✔️ | +| `ROBOTOLOGY_USES_GZ`[3!](#f3) | ✔️ | ❌ | ✔️ | ✔️ | ✔️ | | `ROBOTOLOGY_USES_MUJOCO`[1!](#f1) | ✔️ | ❌ | ✔️ | ✔️ | ✔️ | | `ROBOTOLOGY_USES_PCL_AND_VTK` | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | `ROBOTOLOGY_USES_IGNITION` | ❌ | ❌ | ✔️ | ❌ | ❌ | @@ -107,7 +107,7 @@ Not all options are supported on all platforms. The following table provides a r 2!:`ROBOTOLOGY_ENABLE_ROBOT_TESTING` does not support building with conda-forge dependencies on Apple Silicon. -3!:`ROBOTOLOGY_USES_GZ_SIM` with apt dependencies do not support building on Debian distros (only Ubuntu is supported). Furthermore it does not run on Windows (https://github.com/gazebosim/gz-sim/issues/2089) and have known problems on macOS (https://github.com/robotology/gz-sim-yarp-plugins/issues/90). +3!:`ROBOTOLOGY_USES_GZ` with apt dependencies do not support building on Debian distros (only Ubuntu is supported). Furthermore it does not run on Windows (https://github.com/gazebosim/gz-sim/issues/2089) and have known problems on macOS (https://github.com/robotology/gz-sim-yarp-plugins/issues/90). 4!:`ROBOTOLOGY_USES_OCTAVE` do not support building with apt dependencies on Ubuntu 20.04. @@ -208,10 +208,10 @@ Follow the steps in https://github.com/robotology/icub-models#use-the-models-wi ## Modern Gazebo simulator -Support for this dependency is enabled by the `ROBOTOLOGY_USES_GZ_SIM` CMake option, that enables the software that depends on "Modern Gazebo" (gz-sim). +Support for this dependency is enabled by the `ROBOTOLOGY_USES_GZ` CMake option, that enables the software that depends on "Modern Gazebo" (gz-sim). > [!IMPORTANT] -> At the moment the `ROBOTOLOGY_USES_GZ_SIM` does not run on Windows (https://github.com/gazebosim/gz-sim/issues/2089) and have known problems on macOS (https://github.com/robotology/gz-sim-yarp-plugins/issues/90). Furthermore, it is not supported on non-Ubuntu Debian distributions with apt dependencies. +> At the moment the `ROBOTOLOGY_USES_GZ` does not run on Windows (https://github.com/gazebosim/gz-sim/issues/2089) and have known problems on macOS (https://github.com/robotology/gz-sim-yarp-plugins/issues/90). Furthermore, it is not supported on non-Ubuntu Debian distributions with apt dependencies. diff --git a/doc/conda-forge.md b/doc/conda-forge.md index 09706dd1b..527b1b72c 100644 --- a/doc/conda-forge.md +++ b/doc/conda-forge.md @@ -180,7 +180,7 @@ If you install your dependencies with `conda`, just make sure to install the `ga conda install -c conda-forge gazebo ~~~ -#### `ROBOTOLOGY_USES_GZ_SIM` +#### `ROBOTOLOGY_USES_GZ` If you install your dependencies with `conda`, just make sure to install the `gz-sim8` package: