From 68a337a414c1e96961af5ef3fa87b9ce09acbbe3 Mon Sep 17 00:00:00 2001 From: Louise Poubel Date: Thu, 9 Jun 2022 08:37:51 -0700 Subject: [PATCH] Get started: update to Gazebo and remove link to overview Signed-off-by: Louise Poubel --- get_started.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/get_started.md b/get_started.md index afcfad742..312713377 100644 --- a/get_started.md +++ b/get_started.md @@ -1,30 +1,27 @@ -# Getting Started with Ignition? +# Getting Started with Gazebo? -Welcome to Ignition! - -If you're here and not quite sure what Ignition is all about, then -you might want to give the [Overview](/docs/all/overview) page a quick read. +Welcome to Gazebo! When you're ready, follow the next few steps to get up and running with -simulation using Ignition. +simulation using Gazebo. ## Step 1: Install -Each release of Ignition ships with a new installation tutorial. You can +Each release of Gazebo ships with a new installation tutorial. You can read [the latest installation tutorial here](/docs/latest/install). Please visit the [main documentation](/docs) pages for a list of all releases, along with links to their respective installation tutorials. ## Step 2: Run -After installing Ignition in Step 1, you can launch Gazebo, a 3D robotics +After installing Gazebo in Step 1, you can launch Gazebo Sim, a 3D robotics simulator, from a terminal using ``` ign gazebo shapes.sdf ``` -This command will launch both the Gazebo server and Gazebo GUI with a world +This command will launch both the Sim server and Sim GUI with a world that contains three simple shapes. Add the `-v 4` command line argument to generate error, warning, @@ -34,13 +31,13 @@ informational, and debugging messages on the console. ign gazebo shapes.sdf -v 4 ``` -Gazebo can also be run headless, i.e. without the GUI, by using the `-s` (server only) flag. +Gazebo Sim can also be run headless, i.e. without the GUI, by using the `-s` (server only) flag. ``` ign gazebo -s shapes.sdf -v 4 ``` -Similarly, the GUI can be run independently using the `-g` (gui only) flag. +Similarly, the GUI can be run independently using the `-g` (gui only) flag. On start, the GUI will attempt to connect to a server instance. If a server is not available, then you will see just a blank screen until a server instances is started. @@ -51,13 +48,13 @@ a server instances is started. Take a look at the available [SDF tutorials](http://sdformat.org/tutorials) to get started. -Modifying an existing SDF world is also a good way to get started. Ignition -Gazebo ships with a number of [example SDF +Modifying an existing SDF world is also a good way to get started. Gazebo +Sim ships with a number of [example SDF worlds](https://github.com/ignitionrobotics/ign-gazebo/blob/main/examples/worlds) that you can freely copy and modify. These example SDF files are installed. Many of the SDF files also have instructions located at the top of the SDF file. The instructions typically contain information about how to -run Gazebo with the SDF file in order to experience a particular feature. +run Sim with the SDF file in order to experience a particular feature. There are a wide variety of simulation resources at your disposal on [https://app.ignitionrobotics.org/fuel](https://app.ignitionrobotics.org/fuel). @@ -71,10 +68,10 @@ custom SDF file. ## Step 4: Explore and learn -This tutorial has covered the basics of getting started with Ignition. +This tutorial has covered the basics of getting started with Gazebo. Starting with Citadel, there are more [versioned tutorials](/docs/citadel/tutorials) covering the basics of the GUI, creating worlds and robots, and more. -Each [Ignition library](/libs) also has a set of tutorials and +Each [Gazebo library](/libs) also has a set of tutorials and examples. Explore these resources, and don't forget to ask questions and find solutions at [answers.gazebosim.org](http://answers.gazebosim.org).