From b6ecbd669da64b264c4648c6c77f8b13db725520 Mon Sep 17 00:00:00 2001 From: Martin Pecka Date: Mon, 16 Sep 2024 17:43:11 +0200 Subject: [PATCH] README: Windows-related improvements Signed-off-by: Martin Pecka --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6858c637be..695107209d 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,13 @@ where the YAML files for the packages are found, such as export GZ_CONFIG_PATH=/usr/local/share/gz:$HOME/ws/install/share/gz ``` -where `$HOME/ws` is an example colcon workspace used to build Gazebo +where `$HOME/ws` is an example colcon workspace used to build Gazebo. + +On Windows, `gz sim` (i.e. running both server and GUI in one command) doesn't yet work. +To run Gazebo Sim on Windows, you need to run the server in one terminal (`gz sim -s `) +and the GUI in another terminal (`gz sim -g `). Remember this when reading through +all Gazebo Sim tutorials. Also remember that Conda and `install\setup.bat` need to be sourced +in both terminals (as well as any changes to `GZ_PARTITION` and other environment variables). # Documentation @@ -116,7 +122,7 @@ See the [installation tutorial](https://gazebosim.org/api/sim/9/install.html). See the [installation tutorial](https://gazebosim.org/api/sim/9/install.html). -See the [Writing Tests section of the contributor guide](https://github.com/gazebosim/gz-sim/blob/main/CONTRIBUTING.md#writing-tests) for help creating or modifying tests. +See the [Writing Tests section of the contributor guide](https://gazebosim.org/docs/all/contributing/#writing-tests) for help creating or modifying tests. # Folder Structure