Add vim modelines
[www-quvi.git] / README
blobda7a76427eb194898a1d90e55807b8b2fb22b24b
3 WWW::Quvi
4 ============
6 WWW::Quvi provides a Perl interface to libquvi, a library for parsing video
7 download links.
9 This documentation contains the Perl specific details and some sample code.
10 The libquvi documentation should be consulted for the API details at
11 <http://quvi.googlecode.com/>.
13 WWW: <http://www-quvi.googlecode.com/>
14 GIT: <git://repo.or.cz/www-quvi.git>
17 PREREQUISITES
19   * quvi 0.2.5+  <http://quvi.googlecode.com/>
20     - 0.2.0 should be OK, though some WWW::Quvi tests (e.g. version) *will* fail
22   * Perl 5.8.9+  <http://perl.org/>
24 Additionally (to build):
25   * ExtUtils::MakeMaker <http://search.cpan.org/perldoc?ExtUtils::Depends>
26   * ExtUtils::PkgConfig <http://search.cpan.org/perldoc?ExtUtils::PkgConfig>
27   * ExtUtils::Depends   <http://search.cpan.org/perldoc?ExtUtils::Depends>
30 INSTALLATION
32 To install this module, type the following:
34     perl Makefile.PL
35     make
36     make test (optional, see notes below)
37     make install (see notes below)
40 WHAT IS NOT IMPLEMENTED
42   * Callbacks (e.g. status callback)
44   * Multiple download links per video
47 NOTES
49 * Developed on and for Linux, should port fairly easily to other systems,
50     - Randomly tested on FreeBSD
52 * You can edit CXXFLAGS LDFLAGS, etc. in Makefile.PL
53     - ExtUtils::MakeMaker supports many more (URLs under "See also")
55 * You can specify an install "prefix" with INSTALL_BASE
56     - e.g. perl Makefile.PL INSTALL_BASE=/usr/local
58 * Set HAVE_INTERNET if you want to run the tests depending on the Internet
59     - e.g. env HAVE_INTERNET=1 make test
61 * See also:
62     - <http://search.cpan.org/perldoc?ExtUtils::MakeMaker>
63     - <http://perldoc.perl.org/ExtUtils/MakeMaker/FAQ.html>