Chris@1: ********************************************************************
Chris@1: *                                                                  *
Chris@1: * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
Chris@1: * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
Chris@1: * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
Chris@1: * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
Chris@1: *                                                                  *
Chris@1: * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2011             *
Chris@1: * by the Xiph.Org Foundation http://www.xiph.org/                  *
Chris@1: *                                                                  *
Chris@1: ********************************************************************
Chris@1: 
Chris@1: = WHAT'S HERE =
Chris@1: 
Chris@1: This source distribution includes libogg and nothing else. Other modules 
Chris@1: (eg, the modules libvorbis, vorbis-tools for the Vorbis music codec,
Chris@1: libtheora for the Theora video codec) contain the codec libraries for
Chris@1: use with Ogg bitstreams.
Chris@1: 
Chris@1: Directory:
Chris@1: 
Chris@1: ./src  		The source for libogg, a BSD-license inplementation of 
Chris@1: 		the public domain Ogg bitstream format
Chris@1: 
Chris@1: ./include       Library API headers
Chris@1: 
Chris@1: ./doc           Ogg specification and libogg API documents
Chris@1: 
Chris@1: ./win32		Win32 projects and build automation
Chris@1: 
Chris@1: ./macosx	Mac OS X project and build files
Chris@1: 
Chris@1: = WHAT IS OGG? =
Chris@1: 
Chris@1: Ogg project codecs use the Ogg bitstream format to arrange the raw,
Chris@1: compressed bitstream into a more robust, useful form.  For example,
Chris@1: the Ogg bitstream makes seeking, time stamping and error recovery
Chris@1: possible, as well as mixing several sepearate, concurrent media
Chris@1: streams into a single physical bitstream.
Chris@1: 
Chris@1: = CONTACT =
Chris@1: 
Chris@1: The Ogg homepage is located at 'https://www.xiph.org/ogg/'.
Chris@1: Up to date technical documents, contact information, source code and
Chris@1: pre-built utilities may be found there.
Chris@1: 
Chris@1: BUILDING FROM TARBALL DISTRIBUTIONS:
Chris@1: 
Chris@1: ./configure
Chris@1: make
Chris@1: 
Chris@1: and optionally (as root):
Chris@1: make install
Chris@1: 
Chris@1: This will install the Ogg libraries (static and shared) into
Chris@1: /usr/local/lib, includes into /usr/local/include and API
Chris@1: documentation into /usr/local/share/doc.
Chris@1: 
Chris@1: BUILDING FROM REPOSITORY SOURCE:
Chris@1: 
Chris@1: A standard svn build should consist of nothing more than:
Chris@1: 
Chris@1: ./autogen.sh
Chris@1: make 
Chris@1: 
Chris@1: and as root if desired :
Chris@1: 
Chris@1: make install
Chris@1: 
Chris@1: BUILDING ON WIN32:
Chris@1: 
Chris@1: Use the project file in the win32 directory. It should compile out of the box.
Chris@1: 
Chris@1: CROSS COMPILING FROM LINUX TO WIN32:
Chris@1: 
Chris@1: It is also possible to cross compile from Linux to windows using the MinGW
Chris@1: cross tools and even to run the test suite under Wine, the Linux/*nix
Chris@1: windows emulator.
Chris@1: 
Chris@1: On Debian and Ubuntu systems, these cross compiler tools can be installed
Chris@1: by doing:
Chris@1: 
Chris@1:     sudo apt-get mingw32 mingw32-binutils mingw32-runtime wine
Chris@1: 
Chris@1: Once these tools are installed its possible to compile and test by
Chris@1: executing the following commands, or something similar depending on
Chris@1: your system:
Chris@1: 
Chris@1:     ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \
Chris@1:          --build=i586-linux
Chris@1:     make
Chris@1:     make check
Chris@1: 
Chris@1: (Build instructions for Ogg codecs such as vorbis are similar and may
Chris@1: be found in those source modules' README files)
Chris@1: 
Chris@1: $Id: README 18048 2011-08-04 17:36:32Z giles $