Skip to content

Commit 98c5978

Browse files
iche033mjcarrollahcorde
authored
Update installation instructions (#906)
Signed-off-by: Ian Chen <[email protected]> Signed-off-by: Michael Carroll <[email protected]> Co-authored-by: Michael Carroll <[email protected]> Co-authored-by: Alejandro Hernández Cordero <[email protected]>
1 parent 890cc29 commit 98c5978

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

tutorials/02_install.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ sudo apt-get update
3434
sudo apt-get install libgz-rendering<#>-dev
3535
```
3636

37-
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.
37+
Be sure to replace `<#>` with a number value, such as `7` or `8`, depending on which version you need.
3838

3939
## Source Installation
4040

@@ -70,11 +70,11 @@ build the relevant plugins if dependencies are found.
7070

7171
**OGRE 1.x**
7272
```
73-
# this installs ogre 1.9. Alternatively, you can install 1.8
73+
# this installs ogre 1.9
7474
sudo apt-get install libogre-1.9-dev
7575
```
7676

77-
**OGRE 2.x (supported in Versions >= gz-rendering1)**
77+
**OGRE-Next 2.x**
7878

7979
Add OSRF packages if you have not done so already:
8080
```
@@ -84,9 +84,9 @@ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
8484
sudo apt update
8585
```
8686

87-
Install OGRE 2.2 debs
87+
Install OGRE-Next 2.3 debs
8888
```
89-
sudo apt install libogre-2.2-dev
89+
sudo apt install libogre-next-dev
9090
```
9191

9292
**OptiX (experimental)**
@@ -114,7 +114,7 @@ sdk 4.0.2, comment out lines 167-206).
114114

115115
1. Clone the repository
116116
```
117-
# Optionally, append `-b ign-rendering#` (replace # with a number) to check out a specific version
117+
# Optionally, append `-b gz-rendering#` (replace # with a number) to check out a specific version
118118
git clone http://github.com/gazebosim/gz-rendering
119119
```
120120

@@ -151,7 +151,12 @@ conda activate gz-ws
151151

152152
## Binary Installation
153153

154-
`libgz-rendering<#>` Conda feedstock is not yet available, pending [conda-forge/staged-recipes#13551](https://github.com/conda-forge/staged-recipes/issues/13551).
154+
```bash
155+
conda install libgz-rendering<#> --channel conda-forge
156+
```
157+
158+
Be sure to replace `<#>` with a number value, such as 7 or 8, depending on
159+
which version you need.
155160

156161
## Source Installation
157162

@@ -176,7 +181,7 @@ This assumes you have created and activated a Conda environment while installing
176181

177182
3. Navigate to where you would like to build the library, and clone the repository.
178183
```
179-
# Optionally, append `-b ign-rendering#` (replace # with a number) to check out a specific version
184+
# Optionally, append `-b gz-rendering#` (replace # with a number) to check out a specific version
180185
git clone https://github.com/gazebosim/gz-rendering.git
181186
```
182187

@@ -209,23 +214,23 @@ Install Gazebo Rendering:
209214
brew install gz-rendering<#>
210215
```
211216

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

215220
## Source Installation
216221

217222
1. Clone the repository
218223
```
219-
git clone https://github.com/gazebosim/gz-rendering -b ign-rendering<#>
224+
git clone https://github.com/gazebosim/gz-rendering -b gz-rendering<#>
220225
```
221-
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
226+
Be sure to replace `<#>` with a number value, such as 7 or 8, depending on
222227
which version you need.
223228

224229
2. Install dependencies
225230
```
226231
brew install --only-dependencies gz-rendering<#>
227232
```
228-
Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
233+
Be sure to replace `<#>` with a number value, such as 7 or 8, depending on
229234
which version you need.
230235

231236
3. Configure and build
@@ -273,7 +278,7 @@ To control the testing configuration, use the following environment variables:
273278

274279
```
275280
# Specify the rendering engine to use (ogre, ogre2, optix)
276-
GZ_ENGINE_TO_TEST=ogre2
281+
GZ_ENGINE_TO_TEST=ogre2
277282
278283
# Specify the ogre2 backend to use (vulkan, gl3plus, metal (macOS))
279284
GZ_ENGINE_BACKEND=vulkan

0 commit comments

Comments
 (0)