From 665a0cf274cfde06b23fa75437b8b28f684ae094 Mon Sep 17 00:00:00 2001 From: alters-mit Date: Wed, 12 Aug 2020 16:09:13 -0400 Subject: [PATCH] clarified linux launch instructions --- Documentation/getting_started.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/getting_started.md b/Documentation/getting_started.md index bb11f3944..aac049130 100644 --- a/Documentation/getting_started.md +++ b/Documentation/getting_started.md @@ -56,6 +56,8 @@ c.communicate({"$type": "terminate"}) | ------------------------ | -------------------------- | --------------------------------------- | | `py -3 my_controller.py` | `python3 my_controller.py` | `DISPLAY=:0.0 python3 my_controller.py` | +Note for Linux users: You only need to include `DISPLAY` if the [launch_build parameter in the Controller constructor](python/controller.md) is set to False (by default, it is True). + When you launch run this script, the `Controller` will download the **build**, the binary executable application that runs the simulation environment and then launch the build. The controller will also check to see if your version of TDW is the most recent. For more information on what happens when you start a controller, read [this](misc_frontend/releases.md#Updates). ##### 2b. On a remote Linux server: @@ -76,8 +78,7 @@ NOTE: Not all of these commands will be applicable to every server. The last num ```python from tdw.controller import Controller -display_number = 0 # Set this number to your virtual display. -c = Controller(display=display_number) +c = Controller() print("Everything is OK!") c.communicate({"$type": "terminate"}) ```