Skip to content

Commit 1b90cfd

Browse files
author
Andre Lanrezac
committed
docs: Update usage readme in example
1 parent be53568 commit 1b90cfd

File tree

1 file changed

+44
-16
lines changed

1 file changed

+44
-16
lines changed

example/README.md

Lines changed: 44 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,52 @@
1-
# Usage:
1+
# Usage
22

3-
## Step 1: Server side
4-
- `make prep`
5-
- `make expose_data`
3+
## Client and server on the same machine
4+
5+
- ```bash
6+
make prep
7+
make run
8+
```
9+
- Check the line in the shell and note the `HOSTNAME` and `PORT`:
10+
```bash
11+
MDDriver > Interactive MD bind to /[HOSTNAME]/[PORT]
12+
```
613

7-
## Step 2: Client side
8-
- `make get_data`
14+
- In VMD: open `model.pdb`
15+
- In UnityMol: open `model.nc` or `model.pdb`
16+
- Connect to the server using the `HOSTNAME` and `PORT`
17+
- CTRL + C to stop the server running the simulation
18+
- ```bash
19+
make clean
20+
```
21+
22+
## Client and server on different machines
23+
24+
- Step 1: Server side ⚙️
25+
26+
make prep
27+
make expose_data
28+
29+
30+
- Step 2: Client side 🖥️
31+
32+
make get_data
933

10-
## Step 3: Server side
11-
- CTRL + C to stop the server exposing the data
12-
- `make run` / `make run_now`
13-
- Check the line in the shell and note the `HOSTNAME` and `PORT`:
34+
- Step 3: Server side ⚙️
35+
- CTRL + C to stop the server exposing the data
36+
- ```bash
37+
make run
38+
```
39+
- Check the line in the shell and note the `HOSTNAME` and `PORT`:
1440
```bash
1541
MDDriver > Interactive MD bind to /[HOSTNAME]/[PORT]
1642
```
1743

18-
## Step 4: Client side
19-
- Open `model.nc` or `model.pdb` in VMD or UnityMol
20-
- Connect to the server using the `HOSTNAME` and `PORT`
44+
- Step 4: Client side 🖥️
45+
- In VMD: open `model.pdb`
46+
- In UnityMol: open `model.nc` or `model.pdb`
47+
- Connect to the server using the `HOSTNAME` and `PORT`
2148

22-
## Step 5: Server side
23-
- CTRL + C to stop the server running the simulation
24-
- `make clean`
49+
- Step 5: Server side ⚙️
50+
- CTRL + C to stop the server running the simulation
51+
- ```bash
52+
make clean

0 commit comments

Comments
 (0)