Generate ChangeLog from gitlog
[www-quvi.git] / README
blob5d42c07a179b62c309d5d1658444ead8da54fd1d
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.12+ <http://quvi.googlecode.com/>
20   * Perl 5.8.9+  <http://perl.org/>
22 Additionally (to build):
23   * ExtUtils::MakeMaker <http://search.cpan.org/perldoc?ExtUtils::Depends>
24   * ExtUtils::PkgConfig <http://search.cpan.org/perldoc?ExtUtils::PkgConfig>
25   * ExtUtils::Depends   <http://search.cpan.org/perldoc?ExtUtils::Depends>
28 INSTALLATION
30 To install this module, type the following:
32     perl Makefile.PL
33     make
34     make test (optional, see notes below)
35     make install (see notes below)
38 WHAT IS NOT IMPLEMENTED
40   * Callbacks (e.g. status callback)
42   * Multiple download links per video
45 NOTES
47 * Developed on and for Linux, should port fairly easily to other systems,
48     - Randomly tested on FreeBSD
50 * You can edit CXXFLAGS LDFLAGS, etc. in Makefile.PL
51     - ExtUtils::MakeMaker supports many more (URLs under "See also")
53 * You can specify an install "prefix" with INSTALL_BASE
54     - e.g. perl Makefile.PL INSTALL_BASE=/usr/local
56 * Set HAVE_INTERNET if you want to run the tests depending on the Internet
57     - e.g. env HAVE_INTERNET=1 make test
59 * See also:
60     - <http://search.cpan.org/perldoc?ExtUtils::MakeMaker>
61     - <http://perldoc.perl.org/ExtUtils/MakeMaker/FAQ.html>