Update docs (#944)

This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-11-11 08:58:53 -08:00
1 parent f964e0dfe4
commit 0271c7ded8
2 files changed
+9 -9

No files matched your search

@@ -22,14 +22,6 @@ The connection between the Bridge Server and the Client App works with WebSocket
## Installing and running locally
#### Running the Bridge Server
The viewer bridge server runs on the same machine that you use for training. The training code will connect to this server with a lightweight TCP connection using ZMQ. The training job will launch the viewer bridge server is you specify `--viewer.launch-bridge-server` in the terminal. Otherwise, you can launch the bridge server manually with the following script.
```python
python scripts/viewer/run_bridge_server.py --help
```
#### Running the Client App
```shell
@@ -58,6 +50,14 @@ yarn install
yarn start
```
#### Running the Bridge Server Manually
The viewer bridge server runs on the same machine that you use for training. The training code will connect to this server with a lightweight TCP connection using ZMQ. The training job will launch the viewer bridge server is you specify `--viewer.launch-bridge-server` in the terminal. Otherwise, you can launch the bridge server manually with the following script.
```python
python scripts/viewer/run_bridge_server.py --help
```
## Acknowledgements and references
We thank the authors and contributors to the following repos, which we've started, used, and modified for our use-cases.