Skip to content
This repository was archived by the owner on Jun 17, 2022. It is now read-only.

Commit 9fedac9

Browse files
author
Răzvan C. Rădulescu
committed
Update readme to point out external dependencies
1 parent 8da819f commit 9fedac9

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This is a [standalone python package](https://pypi.org/project/bpsrender/) as we
99

1010
It can be installed as a standalone command line utility [via PiPy](https://pypi.org/project/bpsrender/): `pip install [--user] bpsrender`. *Note* that you have to have `$HOME/.local/bin` included in your `$PATH` environment variable (on unix) if you're going to install the utility locally (using `--user` when executing `pip`).
1111

12-
BPSRender needs ffmpeg and ffprobe to be available on the PATH to work.
1312

1413
## Usage
1514

@@ -50,6 +49,23 @@ optional arguments:
5049
produce the final render
5150
```
5251

52+
## External Dependencies
53+
54+
BPSRender requires
55+
56+
- blender
57+
- ffmpeg
58+
59+
to be available in the PATH environment variable in order to work. In case BPSRender will catch a missing dependency it will throw a message error similar to this:
60+
61+
```
62+
BPSRender couldn't find external dependencies:
63+
[v] blender: /home/razvan/.local/bin/blender
64+
[X] ffmpeg: NOT FOUND
65+
Check if you have them properly installed and available in the PATH environemnt variable.
66+
Exiting...
67+
```
68+
5369
## Known Issues
5470

5571
- [ ] CTRL-C interrupt leaves subprocesses running in the background

0 commit comments

Comments
 (0)