Update CHANGES.
[abby.git] / README
blobf9a86cb41c7375ce4e8086480d0d3df37713bc76
3 README for abby
4 ---------------
6 abby is a front-end for cclive and clive video extraction utilities. It is
7 written in C++ and depends on the Qt framework.
9 abby was originally intended for cclive but additional support for
10 clive was added later in the 0.2.0 release.
13 Using abby as a front-end
14 -------------------------
16 * abby requires a path to either clive(1) or cclive(1) command.
17 This can be defined in the program preferences. abby will also
18 prompt for the path if it is undefined.
20 * The RSS feed parsing feature which was added in abby 0.3.0
21 is intended to replace the clivefeed utility in the clive-utils
22 project.
24 * The video scan feature (or "scan feature") which was added
25 in abby 0.4.0 is intended to replace the clivescan utility
26 in the clive-utils project. The scan feature can be used
27 to scan *any* web page for video links.
29   1. Scan currently detects Youtube videos only
31      * It is uncertain if the support will be expanded
32        to cover other hosts
34      * If there is need for additional support, please
35        contact the author
37   2. Video links can be either "regular" or embedded ones
39   3. Little known facts:
41      * clive previously supported --scan option in 0.1.x - 1.x
43      * the feature was removed in clive 2.x and re-implemented
44        as `clivescan' utility as part of the clive-utils project
46      * abby's scan feature is now the third iteration of the same
47        scan feature that originated in clive 0.1.x
49      * the scan feature has been able to scan videos from Youtube
50        playlists as early as in clive 0.1.x
53 Prerequisites
54 -------------
56 - Qt 4.4+, if you are building abby from the source code, be sure
57 to install the development files
58   
59 Either:
60 - cclive 0.4.4+, from http://code.google.com/p/cclive/
61 Or:
62 - clive 2.2.1+, from http://code.google.com/p/clive/
65 Building abby
66 -------------
68 Normally:
69   qmake-qt4 "QT+=network xml" && make
71 Installation is not currently supported but you may just as well copy
72 the 'abby' executable to your ~/bin directory, for example.