From e8f5ffdacad26eb57725e00695e6a80117d0e8e4 Mon Sep 17 00:00:00 2001 From: Tucker Date: Sun, 24 Jan 2021 20:13:12 -0500 Subject: [PATCH] Clarify steps and fix missing step --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d6c48a4a3..3b4d2eaee8 100644 --- a/README.md +++ b/README.md @@ -228,11 +228,19 @@ If you're comfortable using docker or are on a platform without suitable support ```bash docker run --rm -it -v $(PWD):/src -p 8081:8081 huaweinoah/smarts: -# E.g. docker run --rm -it -v $(PWD):/src -p 8081:8081 huaweinoah/smarts:v0.4.3-pre +# E.g. docker run --rm -it -v $(PWD):/src -p 8081:8081 huaweinoah/smarts:v0.4.12 # # Run Envision server in the background +# This will only need to be run if you want visualisation $ scl envision start -s ./scenarios -p 8081 & + +# Build an example +# This needs to be done the first time and after changes to the example +$ scl scenario build scenarios/loop --clean + +# Run an example +# add --headless if you do not need visualisation $ python examples/single_agent.py scenarios/loop # On your most machine visit http://localhost:8081 to see the running simulation in