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.

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

🌱🥳: Fixes to tutorials #492

Merged
merged 3 commits into from
Sep 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@

Build | Status
-- | --
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-math/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-math/branch/main)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-main-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-main-homebrew-amd64)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-math/branch/gz-math7/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-math/branch/gz-math7)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-gz-math7-focal-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-gz-math7-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-gz-math7-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-gz-math7-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_math-ci-win)](https://build.osrfoundation.org/job/ign_math-ci-win)

Gazebo Math, a component of [Gazebo](https://gazebosim.org), provides general purpose math
Expand Down
17 changes: 15 additions & 2 deletions tutorials/angle.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This tutorial explains how to use the `Angle` class from Gazebo Math library.
Go to `gz-math/examples` and use `cmake` to compile the code:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b main
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down Expand Up @@ -57,12 +57,25 @@ Use the method `Normalized` to bound the value between `-PI` and `PI`.

## Ruby example

This example will only work if the Ruby interface library was compiled and installed. Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:
This example will only work if the Ruby interface library was compiled and installed. For example,
on Ubuntu:

```{.sh}
sudo apt install ruby-gz-math<#>
```

Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:

```{.sh}
export RUBYLIB=/usr/lib/ruby:$RUBYLIB
```

Move to the examples folder:

```{.sh}
cd examples
```

Execute the code:

```{.sh}
Expand Down
18 changes: 16 additions & 2 deletions tutorials/example_angle.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This tutorial explains how to use the `Angle` class from Gazebo Math library.
Go to `gz-math/examples` and use `cmake` to compile the code:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b master
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down Expand Up @@ -57,12 +57,26 @@ Use the method `Normalized` to bound the value between `-PI` and `PI`.

## Ruby example

This example will only work if the Ruby interface library was compiled and installed. Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:
This example will only work if the Ruby interface library was compiled and installed. For example,
on Ubuntu:

```{.sh}
sudo apt install ruby-gz-math<#>
```

Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:

```{.sh}
export RUBYLIB=/usr/lib/ruby:$RUBYLIB
```

Move to the examples folder:

```{.sh}
cd examples
```


Execute the code:

```{.sh}
Expand Down
2 changes: 1 addition & 1 deletion tutorials/example_triangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This tutorial explains how to use the `Triangle` class from Gazebo Math library.
Go to `gz-math/examples` and use `cmake` to compile the code:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b master
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down
19 changes: 16 additions & 3 deletions tutorials/example_vector2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
\page example_vector2 Vector example

This tutorial explains how to use the `Vector` class from Gazebo Math library.
This tutorial explains how to use the `Vector2` class from Gazebo Math library.

## C++ example

Expand All @@ -9,7 +9,7 @@ This tutorial explains how to use the `Vector` class from Gazebo Math library.
To compile the code, go to `gz-math/examples` and use `cmake`:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b master
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down Expand Up @@ -75,12 +75,25 @@ There are also many useful function such as finding the distance between two vec

## Ruby examples

This example will only work if the Ruby interface library was compiled and installed. Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:
This example will only work if the Ruby interface library was compiled and installed. For example,
on Ubuntu:

```{.sh}
sudo apt install ruby-gz-math<#>
```

Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:

```{.sh}
export RUBYLIB=/usr/lib/ruby:$RUBYLIB
```

Move to the examples folder:

```{.sh}
cd examples
```

Execute the examples:

```{.sh}
Expand Down
2 changes: 1 addition & 1 deletion tutorials/rotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This example explains how to use quaternions and euler angles, and how to conver
Go to `gz-math/examples` and use `cmake` to compile the code:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b main
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down
2 changes: 1 addition & 1 deletion tutorials/rotation_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This example explains how to use quaternions and euler angles, and how to conver
Go to `gz-math/examples` and use `cmake` to compile the code:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b master
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down
17 changes: 15 additions & 2 deletions tutorials/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This tutorial explains how to use the `Vector` classes from Gazebo Math library.
To compile the code, go to `gz-math/examples` and use `cmake`:

```{.sh}
git clone https://github.com/gazebosim/gz-math/ -b main
git clone https://github.com/gazebosim/gz-math/ -b gz-math7
cd gz-math/examples
mkdir build
cd build
Expand Down Expand Up @@ -75,12 +75,25 @@ There are also many useful function such as finding the distance between two vec

## Ruby examples

This example will only work if the Ruby interface library was compiled and installed. Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:
This example will only work if the Ruby interface library was compiled and installed. For example,
on Ubuntu:

```{.sh}
sudo apt install ruby-gz-math<#>
```

Modify the `RUBYLIB` environment variable to include the Gazebo Math library install path. For example, if you install to `/usr`:

```{.sh}
export RUBYLIB=/usr/lib/ruby:$RUBYLIB
```

Move to the examples folder:

```{.sh}
cd examples
```

Execute the examples:

```{.sh}
Expand Down