diff --git a/README.md b/README.md index a34408e..0387e9e 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,27 @@ ## Requirements -Python (2.7) needs to be installed; additionally, these packages need to be -installed: -* `py27-yaml` +Python 3.4 or newer needs to be installed. `tivodecode` needs to be available on the path. [mackworth/tivodecode-ng](https://github.com/mackworth/tivodecode-ng) appears to be working well; the original [TiVo File Decoder](http://tivodecode.sourceforge.net) has trouble decoding some files and fails silently. +## Installing + +Create a virtual environment and install the required packages: + +* `python -m venv .venv` or `virtualenv .venv` +* `. .venv/bin/activate` +* `pip install -r requirements.txt` + +## Shell Wrapper + +To make it easier to run tivomirror from cron, the shell wrapper +[`tivomirror`](./tivomirror) will activate the venv and then run +`tivomirror.py`. + ## Configuration `tivomirror` reads a config file, by default `~/.tivo/config.yaml`. The