Skip to content

Commit 0a85554

Browse files
committed
Polished README.md, test requirements, and formatted some code
Signed-off-by: [ 大鳄 ] Asew <[email protected]>
1 parent 65b1afe commit 0a85554

File tree

3 files changed

+3
-4
lines changed

3 files changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Note, the main script can be run from any working directory as PathBench doesn't
3737
| v | Toggle visibility of view editor window |
3838
| m | Toggle map between Sparse and Dense |
3939

40-
Note, screenshots are placed in resources directory.
40+
Note, screenshots are placed in `data/screenshots`.
4141

4242
## Testing
4343

@@ -58,7 +58,7 @@ sudo apt-get install x11vnc xvfb xtightvncviewer
5858

5959
**Example Usage**
6060

61-
1. Running an **individual** test (labyrinth with A* in this case):
61+
1. Running an **individual** graphics test (labyrinth with A* in this case):
6262
```bash
6363
python3 tests/test_algorithm/test_configuration/test_graphics/test_labyrinth_A.py --spawn-display --view-display
6464
```
@@ -69,6 +69,7 @@ python3 tests/run_tests.py --spawn-display --view-display
6969
```
7070

7171
- Specifying `--view-display` will internally execute `vncviewer`. This will result in a white dialog popup. Press `Enter` when it appears, and the interactive view will subsequently appear. However, please wait approximately a second before pressing `Enter`, otherwise the viewer will be created before the view server has had time to initialise, which will prevent launching the interactive view (i.e. no-op).
72+
- Specifying `--spawn-display` for `run_tests.py` will launch an isolated virtual display for each test as they have side-effects, which would cause failures on the CI. As a result, when specifying `--view-display`, the viewer will keep relaunching itself for each graphics test.
7273
- For more usage details specify the help flag `-h`.
7374

7475
Note, to view a screenshot of the screen, execute the following:

tests/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
pyautogui
2-
opencv-python
32
xlib

tests/utils.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import sys
44
import time
55
from functools import partial
6-
76
from typing import List, Tuple, Callable
87

98
g_procs: List[Tuple[subprocess.Popen, Callable[[subprocess.Popen], None]]] = []

0 commit comments

Comments
 (0)