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

Replace ign with gz in installation tutorial #382

Merged
merged 3 commits into from
Sep 13, 2023
Merged

Replace ign with gz in installation tutorial #382

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee45384
Replace ign with gz
iche033 Sep 12, 2023
f975133
update windows installation instructions
iche033 Sep 13, 2023
610092b
consistening version numbering
iche033 Sep 13, 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: 5 additions & 5 deletions tutorials/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,14 @@ Gazebo Sensors requires:

1. Clone the repository
```
git clone https://github.com/gazebosim/gz-sensors -b ign-sensors<#>
git clone https://github.com/gazebosim/gz-sensors -b gz-sensors<#>
```
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
which version you need.

2. Install dependencies
```
brew install --only-dependencies ignition-sensors<#>
brew install --only-dependencies gz-sensors<#>
```
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
which version you need.
Expand Down Expand Up @@ -143,7 +143,7 @@ Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes availab

2. Navigate to where you would like to build the library, and clone the repository.
```
# Optionally, append `-b ign-sensors#` (replace # with a number) to check out a specific version
# Optionally, append `-b gz-sensors#` (replace # with a number) to check out a specific version
git clone https://github.com/gazebosim/gz-sensors.git
```

Expand All @@ -154,9 +154,9 @@ Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes availab
cd build
```

4. Before `gz-rendering` becomes available on conda-forge, we need to build it from source and specify the path containing `gz-rendering-config.cmake` in `CMAKE_PREFIX_PATH`, for cmake to find `gz-rendering`. That path could be `gz-rendering-install-path\lib\cmake\gz-rendering4`, for example.
4. Before `gz-rendering` becomes available on conda-forge, we need to build it from source and specify the path containing `gz-rendering-config.cmake` in `CMAKE_PREFIX_PATH`, for cmake to find `gz-rendering`. That path could be `gz-rendering-install-path\lib\cmake\gz-rendering8`, for example.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjcarroll the windows instructions are probably out of date? Is it possible to just do
conda install libgz-sensors<#> / conda install libgz-rendering<#>?

Copy link
Contributor

Choose a reason for hiding this comment

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

That is correct:

https://prefix.dev/channels/conda-forge/packages/gz-sensors7
https://prefix.dev/channels/conda-forge/packages/gz-rendering7

The harmonic versions will come when we have official tags, according to @traversaro

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, conda-forge does not do prerelease in general, see https://conda-forge.org/docs/maintainer/knowledge_base.html#pre-release-builds .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated windows instructions in f975133

```
cmake .. -DBUILD_TESTING=OFF -DCMAKE_PREFIX_PATH=path\containing\ignition-rendering-config # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
cmake .. -DBUILD_TESTING=OFF -DCMAKE_PREFIX_PATH=path\containing\gz-rendering-config # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
cmake --build . --config Release
```

Expand Down