From 64023478cbd4ddd5dd1c2943cb9e8caf10c12acf Mon Sep 17 00:00:00 2001 From: ahcorde Date: Mon, 5 Sep 2022 20:11:41 +0200 Subject: [PATCH] Improved installation tutorial Signed-off-by: ahcorde --- tutorials/installation.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/tutorials/installation.md b/tutorials/installation.md index cdb1f23b6..922593e5a 100644 --- a/tutorials/installation.md +++ b/tutorials/installation.md @@ -30,7 +30,8 @@ sudo apt install libgz-math<#>-dev ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on -which version you need. +which version you need. From version 7 you should use `gz-math<#>` but for lower versions +you should use `ign-math<#>`. ### macOS @@ -46,7 +47,8 @@ Install Gazebo Math: ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on -which version you need. +which version you need. From version 7 you should use `gz-math<#>` but for lower versions +you should use `ign-math<#>`. ## Windows @@ -65,7 +67,8 @@ conda install libgz-math<#> --channel conda-forge ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on -which version you need. +which version you need. From version 7 you should use `gz-math<#>` but for lower versions +you should use `ign-math<#>`. # Source Installation @@ -127,10 +130,11 @@ The optional Eigen component of Gazebo Math requires: 3. Clone the repository ``` - git clone https://github.com/gazebosim/gz-math -b ign-math<#> + git clone https://github.com/gazebosim/gz-math -b gz-math<#> ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on - which version you need. + which version you need. From version 7 you should use `gz-math<#>` but for lower versions + you should use `ign-math<#>`. 4. Configure and build ``` @@ -150,17 +154,19 @@ The optional Eigen component of Gazebo Math requires: 1. Clone the repository ``` - git clone https://github.com/gazebosim/gz-math -b ign-math<#> + git clone https://github.com/gazebosim/gz-math -b gz-math<#> ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on - which version you need. + which version you need. From version 7 you should use `gz-math<#>` but for lower versions + you should use `ign-math<#>`. 2. Install dependencies ``` brew install --only-dependencies gz-math<#> ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on - which version you need. + which version you need. From version 7 you should use `gz-math<#>` but for lower versions + you should use `ign-math<#>`. 3. Configure and build ``` @@ -190,6 +196,7 @@ The optional Eigen component of Gazebo Math requires: ``` conda search libgz-math* --channel conda-forge --info ``` + From version 7 you should use `gz-math<#>` but for lower versions you should use `ign-math<#>`. See the [Conda release repository](https://github.com/conda-forge/libignition-math4-feedstock) for more information. Install dependencies, replacing `<#>` with the desired version: @@ -199,9 +206,11 @@ The optional Eigen component of Gazebo Math requires: 3. Navigate to where you would like to build the library, and clone the repository. ``` - # Optionally, append `-b ign-math#` (replace # with a number) to check out a specific version + # Optionally, append `-b gz-math#` (replace # with a number) to check out a specific version git clone https://github.com/gazebosim/gz-math.git ``` + From version 7 you should use `gz-math<#>` but for lower versions + you should use `ign-math<#>`. 4. Configure and build ```