Improved README

[webdl] / README.md

diff --git a/README.md b/README.md
index 0f573adbc997f236d69055e9f05baca262ddad82..f3587051eea74b86e913b854dca8dfc02a428294 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,34 +2,26 @@
 
 WebDL is a set of Python scripts to grab video from online Free To Air Australian channels.
 
-## Requirements
-
-* [Livestreamer](http://docs.livestreamer.io/install.html)
-* python 2.7 or 3.2+
-* pycrypto -- Livestreamer needs this for some videos
-* python-lxml
-* ffmpeg / libav-tools
 
 ## Installation
 
-### Arch Linux
-    pacman -S livestreamer python-crypto python-lxml ffmpeg
-
-### Ubuntu
-    apt-get install livestreamer python-crypto python-lxml libav-tools
-
-### Mac OS X
-
-Warning, this is untested!
+Install the following packages using your package manager:
 
-    brew install python3 ffmpeg
-    pip3 install livestreamer pycrypto lxml
+* Python 3.2+
+* ffmpeg or libav-tools
 
-### Then get WebDL itself
-    hg clone https://bitbucket.org/delx/webdl
-    cd webdl
-    python3 ./grabber.py
+Clone the WebDL repository:
+```
+git clone https://bitbucket.org/delx/webdl
+cd webdl
+```
 
+Set up a Python virtualenv and use pip to install the other dependencies:
+```
+virtualenv --python python3 .virtualenv
+. .virtualenv/bin/activate
+pip install -r requirements.txt
+```
 
 ## Interactive usage (grabber.py)
 
@@ -70,21 +62,21 @@ The bolded parts are what you type. Note that you can go back on any screen by t
 
 ## Cron scripted usage (autograbber.py)
 
-I have a shell script which looks something like this, I run it daily from crontab.
+You can schedule a regular download of your favourite shows.
 
 ```
 # m    h  dom mon dow   command
-  0    1   *   *   *     ./autograbber.py /path/to/video-dir/ /path/to/patterns.txt
+  0    1   *   *   *     ./autograbber.py /videos/ABC4Kids /videos/Insight
 ```
 
-The patterns.txt file should contain shell-style globs, something like:
+Each of these directories should contain a `.patterns.txt` with shell-style globs:
 
 ```
-ABC iView/*/QI*/*
-SBS/Programs/Documentary/*/*
+ABC iView/By Channel/ABC4Kids/*/*
+SBS/Channel/SBS1/Insight*
 ```
 
-The above will download all episodes of QI from ABC as well as every SBS documentary. Whenever an episode is downloaded it is recorded into downloaded_auto.txt. Even if you move the files somewhere else they will not be redownloaded.
+Whenever an episode is downloaded it is recorded into `.downloaded_auto.txt`. Even if you move the files somewhere else they will not be redownloaded.
 
 
 ## Bug reports