Skip to content

Commit 46c17b9

Browse files
committed
[readme] fix preview instructions, elucidate non-nvidia alternatives
1 parent 2db86a5 commit 46c17b9

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,35 @@ Although designed for py_trees, the js libs (in particular, the interfaces) are
2525

2626
## Preview
2727

28+
With VSCode DevContainers and on a PC with an NVIDIA GPU:
29+
30+
* Install [VSCode](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions)
31+
* Install the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#docker)
32+
* Clone and launch the demo:
33+
2834
```
2935
$ git clone https://github.com/splintered-reality/py_trees_js
3036
$ code .
37+
$ cd py_trees_js
38+
3139
# Reopen the project in the devcontainer
40+
$ (use CTRL-SHIFT-P if you miss VSCode's helper dialog)
41+
42+
# Setup and launch
3243
$ poetry install
33-
$ poetry shell
34-
$ py-trees-demo-viewer
44+
$ poetry run py-trees-demo-viewer
3545
```
3646
<p align="center">
3747
<img src="images/splash.png" width="80%"/>
3848
<img src="images/screenshot.png" width="100%"/>
3949
</p>
4050

51+
If you do not have a PC that meets those requirements, some alternative options:
52+
53+
* Install [Poetry](https://python-poetry.org/) and PyQt on your system or in a venv. Clone and launch.
54+
* If you're just interested in seeing the demo viewer, `pip install --user py_trees_js` and launch the viewer
55+
* Create your own devcontainer with something like the [desktop-lite](https://github.com/devcontainers/features/tree/main/src/desktop-lite) feature. If this works, send me a PR!
56+
4157
## Example - Simple Web App
4258

4359
Building a complete application that can render a behaviour tree stream is an effort that can be decomposed into two tasks:

0 commit comments

Comments
 (0)