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