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