Skip to content

Commit 05a20df

Browse files
committed
Update README
1 parent e1e86ca commit 05a20df

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ Python interface for ra2yrcpp.
88

99
Install a pre-built wheel:
1010
```bash
11-
pip install -U https://github.com/shmocz/pyra2yr/releases/download/v0.2.0/pyra2yr-0.2.0-py3-none-any.whl
11+
pip install -U https://github.com/shmocz/pyra2yr/releases/download/v0.3.0/pyra2yr-0.3.0-py3-none-any.whl
1212
```
1313

14-
### (TODO) Method 2: Install with poetry
14+
### Method 2: Install with poetry
15+
16+
TODO
1517

1618
## Setup
1719

@@ -26,3 +28,26 @@ Download and extract [ra2yrcpp](https://github.com/shmocz/ra2yrcpp/releases/down
2628
## Usage
2729

2830
See `pyra2yr/examples/basic_usage.py` files for example usage.
31+
32+
## Tests
33+
34+
In a suitable python environment, run:
35+
36+
```bash
37+
python -m unittest
38+
```
39+
40+
Various environment variables are accepted:
41+
42+
- `USE_SYRINGE` if defined, use Syringe instead of legacy spawner. Assumes `Syringe.exe` is in game data folder.
43+
- `USE_X11` (Linux only) Use host X server instead of VNC by exposing `/tmp/.X11-unix` to container.
44+
- `X11_SOCKET` (Linux only) is `USE_X11` is defined alternative path to X server socket.
45+
46+
> [!NOTE]
47+
> Any value will enable a boolean setting, even values like `no`, `False` and `n`.
48+
49+
For example:
50+
51+
```bash
52+
USE_SYRINGE=y USE_X11=y python -m unittest
53+
```

0 commit comments

Comments
 (0)