speling fix

[platform/upstream/libvorbis.git] / README

diff --git a/README b/README
index 4f593e1..3ff8060 100644 (file)
--- a/README
+++ b/README
@@ -1,33 +1,62 @@
 ********************************************************************
 *                                                                  *
 ********************************************************************
 *                                                                  *

-* THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
-* USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
-* THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE.    *
-* PLEASE READ THESE TERMS DISTRIBUTING.                            *
+* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
+* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
+* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
+* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *

 *                                                                  *
 *                                                                  *

-* THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000             *
-* by Monty <monty@xiph.org> and The XIPHOPHORUS Company            *
-* http://www.xiph.org/                                             *
+* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001             *
+* by the XIPHOPHORUS Company http://www.xiph.org/                  *

 *                                                                  *
 ********************************************************************
 
 *                                                                  *
 ********************************************************************
 

+NEW AND IMPORTANT:
+
+If you're used to the source distribution from the first two beta
+relaeases, things are now rearranged a bit.  Specifically, the
+'vorbis' CVS module contains only the libvorbis, libvorbisfile, and
+libvorbisenc libraries.  Because Ogg bitstreams are to be used by other 
+Ogg codecs, Ogg framing and streaming functionality is now in libogg 
+(the 'ogg' CVS module).  Vorbis utilities are in 'vorbis-tools' and various
+player plugins are in 'vorbis-plugins'.  For now, you'll need to check
+out these other modules seperately. (Note: the xmms plugin is in the xmms
+CVS tree in xmms/Input/vorbis.)
+
+Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
+'./configure; make', the proper build sequence (in each module) is
+'./autogen.sh; make'.
+
+You will also need the newest versions of autoconf, automake, and libtool
+in order to compile vorbis from CVS.  configure scripts are provided for you
+in tarball distributions.
+

 WHAT'S HERE:
 
 WHAT'S HERE:
 

-This source distribution includes libvorbis, a full-featured example
+This source distribution includes libvorbis and an example

 encoder/player to demonstrate use of libvorbis and documentation on
 the Ogg Vorbis audio coding format.
 
 Directory:
 
 encoder/player to demonstrate use of libvorbis and documentation on
 the Ogg Vorbis audio coding format.
 
 Directory:
 

-./lib                  The source for libvorbis, an LGPLed inplementation of 
-               the public domain OggSquish Vorbis audio encoding
+./lib                  The source for the libraries, an LGPLed implementation of 
+               the public domain Ogg Vorbis audio encoding

                format.
 
                format.
 

-./cmdline      A full-featured command line encoder/decoder/player
-               utility ('vorbis') that demonstrates programmatic use
-               of libvorbis.
+./include       Library API headers
+
+./debian        Rules/spec files for building Debian .deb packages
+
+./doc           Vorbis documentation
+
+./examples     Example code illustrating programmatic use of libvorbis, 
+               libvorbisfile and libvorbisenc

 
 

-./docs          Vorbis specification documents
+./mac          Codewarrior project files and build tweaks for MacOS.
+
+./win32                Win32 projects files and build automation
+
+./vq           Internal utilities for training/building new LSP/residue 
+               and auxiliary codebooks.

 
 WHAT IS VORBIS:
 
 
 WHAT IS VORBIS:
 


@@ -40,34 +69,75 @@ All the technical details are published and documented, and any
 software entity may make full use of the format without royalty or
 patent concerns.
 
 software entity may make full use of the format without royalty or
 patent concerns.
 

-This package contains libvorbis, an LGPLed software implementation of
+This package contains:
+
+.) libvorbis, a BSD-license software implementation of

 the Vorbis specification by the Xiphophorus company
 the Vorbis specification by the Xiphophorus company

-(http://www.xiph.org/), vorbisfile, an LGPLed convenience library
+(http://www.xiph.org/) 
+
+.) libvorbisfile, a BSD-license convenience library

 built on Vorbis designed to simplify common uses and a number of GPL
 built on Vorbis designed to simplify common uses and a number of GPL

-example programs, utilities and player plugins.
+example programs
+
+.) libvorbisenc, a BSD-license library that provides a simple, programmatic
+encoding setup interface 
+
+.) example code making use of libogg, libvorbis, libvorbisfile and
+libvorbisenc

 
 CONTACT:
 
 
 CONTACT:
 

-The OggSquish homepage is located at 'http://www.xiph.org/ogg/'.
+The Ogg homepage is located at 'http://www.xiph.org/ogg/'.

 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
 Up to date technical documents, contact information, source code and
 pre-built utilities may be found there.
 
 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
 Up to date technical documents, contact information, source code and
 pre-built utilities may be found there.
 

-BUILD:
+BUILDING FROM CVS:

 
 

-A standard build should consist of nothing more than:
-
-./configure
+./autogen.sh

 make 
 
 make 
 

-and as root if desired :
+and as root if desired:

 
 make install
 
 
 make install
 

-This will install the ogg vorbis commandline encoder/player ('ogg')
-into /usr/local/bin, the ogg player and libvorbis manpages into
-/usr/local/man/ and libvorbis.a into /usr/local/lib.
+This will install the vorbis libraries (static and shared) into
+/usr/local/lib, includes into /usr/local/include and API manpages
+(once we write some) into /usr/local/man.
+
+BUILDING FROM TARBALL DISTRIBUTIONS:
+
+./configure
+make
+
+and optionally (as root):
+make install
+
+BUILDING RPMS:
+
+after normal configuring:
+
+make dist
+rpm -ta libvorbis-<version>.tar.gz
+
+BUILDING ON MACOS 9:
+
+Vorbis on MacOS 9 is built using CodeWarrior 5.3.  To build it, first
+verify that the Ogg libraries are already built following the
+instructions in the Ogg module README.  Open vorbis/mac/libvorbis.mcp,
+switch to the "Targets" pane, select everything, and make the project.
+Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
+that order).  vorbis/mac/Output you will now have both debug and final
+versions of Vorbis shared libraries to link your projects against.
+
+To build a project using Ogg Vorbis, add access paths to your
+CodeWarrior project for the ogg/include, ogg/mac/Output,
+vorbis/include, and vorbis/mac/Output folders.  Be sure that
+"interpret DOS and Unix paths" is turned on in your project; it can
+be found in the "access paths" pane in your project settings.  Now
+simply add the shared libraries you need to your project (OggLib and
+VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
+wherever you need to acces Ogg and Vorbis functionality.

 
 

-Monty <monty@xiph.org>, <xiphmont@mit.edu>

 
 

-$Id: README,v 1.4 2000/05/12 21:42:04 xiphmont Exp $
+$Id: README,v 1.10 2001/03/22 01:16:22 segher Exp $