Fix document installation path for packaging
[liboggplay.git] / README
blob5ba3d83e1f16dded47bff5878660a80008ed3498
1 OggPlay: a library for playing Ogg multimedia
3 Overview
4 --------
6 The current version of the plugin is still under development therefore
7 the setup requires manual installation of the plugin. For more information,
8 see also:
10   http://wiki.xiph.org/index.php/OggPlay
12 Dependencies
13 ------------
15 For the core library (liboggplay), you need
17   * libogg, libvorbis, libtheora, optionally libspeex -- from http://www.xiph.org/
19     svn co http://svn.xiph.org/trunk/ogg/ ogg
20     svn co http://svn.xiph.org/trunk/vorbis/ vorbis
21     svn co http://svn.xiph.org/trunk/theora/ theora
23   * liboggz and libfishsound -- from svn.annodex.net:
25     git clone git://git.xiph.org/liboggz.git
26     git clone git://git.xiph.org/libfishsound.git
28 Optionally, for Kate stream support, you need
30   * libkate -- from http://libkate.googlecode.com/
32 To render Kate streams as video overlays, you need
34   * libtiger -- from http://libtiger.googlecode.com/
36 Note that libtiger needs Pango and Cairo:
38   * Pango -- http://www.pango.org/
39   * Cairo -- http://cairographics.com/
41 See the README files associated with these libraries for installation
42 instructions.
44 To build src/examples/glut-player, you need:
45   * The core liboggplay dependencies (listed above)
46   * GLUT -- see http://www.opengl.org/resources/libraries/
48 To build src/examples/dump-all-streams, you need:
49   * The core liboggplay dependencies (listed above)
50   * libsndfile -- from http://www.mega-nerd.com/libsndfile/
52 To build src/tools/oggplay-dump-first-frame, you need:
53   * The core liboggplay dependencies (listed above)
54   * Imlib2 -- from your distribution or from 
55               http://sourceforge.net/project/showfiles.php?group_id=2&package_id=11130
57 On Debian, the required packages for all these additional libraries are:
58   g++ libogg-dev libvorbis-dev libspeex-dev libtheora-dev libsndfile1-dev
59   libimlib2-dev libglut-dev
61 Compile and Install liboggplay
62 ------------------------------
64 ./autogen.sh
65 ./configure
66 make && make install