Skip to content

Commit 81a97f1

Browse files
authored
Add a comment on get_started for the use of ign in Citadel/Fortress (#409)
Signed-off-by: Jose Luis Rivero <jrivero@osrfoundation.org>
1 parent 304a7a2 commit 81a97f1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

get_started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ simulator, from a terminal.
4444
Launch Gazebo by running:
4545

4646
```
47-
gz sim shapes.sdf
47+
gz sim shapes.sdf # Fortress and Citadel use "ign gazebo" instead of "gz sim"
4848
```
4949

5050
This command will launch both the Sim server and Sim GUI with a world
@@ -54,13 +54,13 @@ Add the `-v 4` command line argument to generate error, warning,
5454
informational, and debugging messages on the console.
5555

5656
```
57-
gz sim shapes.sdf -v 4
57+
gz sim shapes.sdf -v 4 # Fortress and Citadel use "ign gazebo" instead of "gz sim"
5858
```
5959

6060
Gazebo Sim can also be run headless, i.e. without the GUI, by using the `-s` (server only) flag.
6161

6262
```
63-
gz sim -s shapes.sdf -v 4
63+
gz sim -s shapes.sdf -v 4 # Fortress and Citadel use "ign gazebo" instead of "gz sim"
6464
```
6565

6666
Similarly, the GUI can be run independently using the `-g` (gui only) flag.
@@ -109,12 +109,12 @@ and another for the GUI:
109109

110110
```sh
111111
# launch server in one terminal
112-
gz sim -v 4 shapes.sdf -s
112+
gz sim -v 4 shapes.sdf -s # Fortress and Citadel use "ign gazebo" instead of "gz sim"
113113
```
114114

115115
```sh
116116
# launch gui in a separate terminal
117-
gz sim -v 4 -g
117+
gz sim -v 4 -g # Fortress and Citadel use "ign gazebo" instead of "gz sim"
118118
```
119119

120120
The GUI on macOS is currently known to be unstable. Basic interaction with

0 commit comments

Comments
 (0)