Update to reflect latest changes
This commit is contained in:
parent
40caba68fc
commit
a70203ae95
1 changed files with 15 additions and 3 deletions
18
README.md
18
README.md
|
@ -2,15 +2,27 @@
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Python (2.7) needs to be installed; additionally, these packages need to be
|
Python 3.4 or newer needs to be installed.
|
||||||
installed:
|
|
||||||
* `py27-yaml`
|
|
||||||
|
|
||||||
`tivodecode` needs to be available on the path. [mackworth/tivodecode-ng](https://github.com/mackworth/tivodecode-ng)
|
`tivodecode` needs to be available on the path. [mackworth/tivodecode-ng](https://github.com/mackworth/tivodecode-ng)
|
||||||
appears to be working well; the original
|
appears to be working well; the original
|
||||||
[TiVo File Decoder](http://tivodecode.sourceforge.net) has trouble
|
[TiVo File Decoder](http://tivodecode.sourceforge.net) has trouble
|
||||||
decoding some files and fails silently.
|
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
|
## Configuration
|
||||||
|
|
||||||
`tivomirror` reads a config file, by default `~/.tivo/config.yaml`. The
|
`tivomirror` reads a config file, by default `~/.tivo/config.yaml`. The
|
||||||
|
|
Loading…
Reference in a new issue