Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved installation tutorial #493

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Improved installation tutorial #493

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6402347
Improved installation tutorial
ahcorde Sep 5, 2022
300ad3f
Merge branch 'gz-math7' into ahcorde/7/update_tutorial
ahcorde Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions tutorials/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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
```
Expand All @@ -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
```
Expand Down Expand Up @@ -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:
Expand All @@ -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
```
Expand Down