tuning on a branch. New noise metrics, noise bugfixes, postecho on.

[platform/upstream/libvorbis.git] / README

diff --git a/README b/README
index 8a028d9..0cb8268 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,19 @@
 ********************************************************************
 *                                                                  *
-* THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
-* USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
-* THE GNU LESSER/LIBRARY 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
+releases, 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 
@@ -39,9 +38,8 @@ the Ogg Vorbis audio coding format.
 
 Directory:
 
-./lib                  The source for the libraries, an LGPLed inplementation of 
-               the public domain Ogg Vorbis audio encoding
-               format.
+./lib                  The source for the libraries, a BSD-license implementation
+               of the public domain Ogg Vorbis audio encoding format.
 
 ./include       Library API headers
 
@@ -72,15 +70,15 @@ patent concerns.
 
 This package contains:
 
-.) libvorbis, an LGPLed software implementation of
+.) libvorbis, a BSD-license software implementation of
 the Vorbis specification by the Xiphophorus company
 (http://www.xiph.org/) 
 
-.) libvorbisfile, an LGPLed convenience library
+.) libvorbisfile, a BSD-license convenience library
 built on Vorbis designed to simplify common uses and a number of GPL
 example programs
 
-.) libvorbisenc, an LGPL library that provides a simple, programmatic
+.) libvorbisenc, a BSD-license library that provides a simple, programmatic
 encoding setup interface 
 
 .) example code making use of libogg, libvorbis, libvorbisfile and
@@ -121,4 +119,24 @@ after normal configuring:
 make dist
 rpm -ta libvorbis-<version>.tar.gz
 
-$Id: README,v 1.7 2000/11/08 08:45:30 jack Exp $
+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).  In 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 access Ogg and Vorbis functionality.
+
+
+$Id: README,v 1.11 2001/03/22 01:33:20 segher Exp $