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.

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

Add section on macOS in get started page #346

Merged
merged 1 commit into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion garden/install_osx_src.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ You should now be able to launch gazebo:
# launch server in one terminal
gz sim -v 4 shapes.sdf -s

# launch gui in a seprate terminal
# launch gui in a separate terminal
# remember to source the workspace setup script
gz sim -v 4 -g
```
Expand Down
28 changes: 27 additions & 1 deletion get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ installation options:
## Step 2: Run

After installing Gazebo in Step 1, you can launch Gazebo Sim, a 3D robotics
simulator, from a terminal using
simulator, from a terminal.

* If you are on macOS, see specific instructions in the [macOS section](#macos).

Launch Gazebo by running:

```
gz sim shapes.sdf
Expand Down Expand Up @@ -97,3 +101,25 @@ covering the basics of the GUI, creating worlds and robots, and more.
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).

# macOS

On macOS, you will need to run Gazebo using two terminals, one for the server
and another for the GUI:

```sh
# launch server in one terminal
gz sim -v 4 shapes.sdf -s
```

```sh
# launch gui in a separate terminal
gz sim -v 4 -g
```

The GUI on macOS is currently known to be unstable. Basic interaction with
the 3D scene such as camera view control and translation / rotation tools
should be functional. However, some GUI plugins like the Component Inspector
may be buggy and interaction with certain GUI elements may cause the GUI
to crash. Please ticket an issue at https://github.com/gazebosim/gz-sim/
if you run into GUI problems on macOS.
2 changes: 1 addition & 1 deletion harmonic/install_osx_src.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ You should now be able to launch gazebo:
# launch server in one terminal
gz sim -v 4 shapes.sdf -s

# launch gui in a seprate terminal
# launch gui in a separate terminal
# remember to source the workspace setup script
gz sim -v 4 -g
```
Expand Down