Skip to content

Commit fde53a6

Browse files
authored
Add a note about glut dependency in installation tutorial (#1163)
Signed-off-by: Ian Chen <[email protected]>
1 parent fdcd88e commit fde53a6

14 files changed

+63
-3
lines changed

.github/ci/packages.apt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
freeglut3-dev
2-
libfreeimage-dev
32
libglew-dev
43
libgz-cmake5-dev
54
libgz-common7-dev

tutorials/02_install.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Be sure to replace `<#>` with a number value, such as `7` or `8`, depending on w
4040

4141
### Prerequisites
4242

43-
Ubuntu Focal 20.04 or above:
43+
Ubuntu Noble 24.04 or above:
4444

4545
Install dependencies:
4646
```
@@ -53,7 +53,6 @@ sudo apt install -y \
5353
pkg-config \
5454
git \
5555
libglew-dev \
56-
libfreeimage-dev \
5756
freeglut3-dev \
5857
libxmu-dev \
5958
libxi-dev \
@@ -63,6 +62,8 @@ sudo apt install -y \
6362
libgz-plugin4-dev
6463
```
6564

65+
Note that `freeglut3-dev` is necessary for running demos in the examples directory.
66+
6667
### Supported Rendering Engines
6768

6869
Gazebo Rendering will look for rendering libraries installed in the system and

tutorials/10_actor_animation_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This tutorial will show you how to use the Gazebo Rendering library to create an actor animation.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, Create a build directory and use `cmake` and `make` to compile the code:

tutorials/12_mesh_viewer_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
\page mesh_viewer Mesh Viewer
22

3+
## Install prerequisites
4+
5+
In order to compile the example in this tutorial, make sure to install the
6+
dependencies listed in the \subpage installation tutorial.
7+
38
## Compile and run the example
49

510
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/13_custom_scene_viewer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Some of the scenes available include:
1717

1818
There are some scenes demonstrating reflective materials and multiple point light shadows but they appear the same in ogre because they are not supported.
1919

20+
## Install prerequisites
21+
22+
In order to compile the example in this tutorial, make sure to install the
23+
dependencies listed in the \subpage installation tutorial.
24+
2025
## Compile and run the example
2126

2227
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/14_camera_tracking_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This example shows a camera tracking a moving target. You can use the keyboard to move the target being tracked, toggle between different tracking modes, and adjust the tracking offsets.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/15_custom_shaders_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This example shows how use custom shaders in gz-rendering to change the appearance of objects in the scene. It demonstrates two uses of shaders: The first is setting shaders for a camera and the other is setting shaders for an object in the scene.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/17_render_pass_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This example demonstrates the use of the render pass system for adding Gaussian noise post-processing effect to a camera.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/18_simple_demo_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This example shows how move the camera automatically.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

tutorials/19_text_geom_tutorial.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This example shows how to include text in the scene.
44

5+
## Install prerequisites
6+
7+
In order to compile the example in this tutorial, make sure to install the
8+
dependencies listed in the \subpage installation tutorial.
9+
510
## Compile and run the example
611

712
Clone the source code, create a build directory and use `cmake` and `make` to compile the code:

0 commit comments

Comments
 (0)