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

Changes ignition for gz in tutorial commands #570

Merged
merged 4 commits into from
Sep 14, 2023
Merged

Changes ignition for gz in tutorial commands #570

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25b7585
Changes ignition for gz in tutorial commands
Voldivh Sep 14, 2023
9e98e4f
Adds note regarding the change of ign to gz
Voldivh Sep 14, 2023
4e90912
Changes suggested version number
Voldivh Sep 14, 2023
15df2c9
Moves note to the beggining of the tutorial page
Voldivh Sep 14, 2023
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
10 changes: 6 additions & 4 deletions tutorials/01_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The source install instructions should be used if you need the very latest
software improvements, if you need to modify the code, or if you plan to make a
contribution.

**Note:** If the version is 6 or downwards replace `gz-gui<#>` for `ign-gui<#>` in the command line. For more information take a look [here](https://community.gazebosim.org/t/a-new-era-for-gazebo/1356).

## Binary Install

### Ubuntu
Expand Down Expand Up @@ -98,16 +100,16 @@ Build and install as follows:

1. Clone the repository
```
git clone https://github.com/gazebosim/gz-gui -b ign-gui<#>
git clone https://github.com/gazebosim/gz-gui -b gz-gui<#>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a note that if the version is > gui7 then to use ign-? It also might be good to add a link to this post: https://community.gazebosim.org/t/a-new-era-for-gazebo/1356

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Could you take a look?

Copy link
Contributor

@jennuine jennuine Sep 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Statement looks good, do you mind putting it closer to the beginning of this document, right above Binary Install heading here:

gz-gui/tutorials/01_install.md

Lines 17 to 18 in db15648

## Binary Install

I'd make sure to add a empty row before and afterwards so the Note is on it's own line, rather than part of the previous sentence.

```
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
Be sure to replace `<#>` with a number value, such as 7 or 8, depending on
which version you need.

2. Install dependencies
```
brew install --only-dependencies ignition-gui<#>
brew install --only-dependencies gz-gui<#>
```
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
Be sure to replace `<#>` with a number value, such as 7 or 8, depending on
which version you need.

3. Configure and build
Expand Down