Initial revision
[platform/upstream/libvorbis.git] / README
1 ********************************************************************
2 *                                                                  *
3 * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
5 * THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE.    *
6 * PLEASE READ THESE TERMS DISTRIBUTING.                            *
7 *                                                                  *
8 * THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-1999             *
9 * by Monty <monty@xiph.org> and The XIPHOPHORUS Company            *
10 * http://www.xiph.org/                                             *
11 *                                                                  *
12 ********************************************************************
13
14 WHAT'S HERE:
15
16 This source distribution includes libvorbis, a full-featured example
17 encoder/player to demonstrate use of libvorbis and documentation on
18 the Ogg Vorbis audio coding format.
19
20 Directory:
21
22 ./lib           The source for libvorbis, a GPLed inplementation of 
23                 the public domain OggSquish Vorbis audio encoding
24                 format.
25
26 ./cmdline       A full-featured command line encoder/decoder/player
27                 utility ('vorbis') that demonstrates programmatic use
28                 of libvorbis.
29
30 ./docs          Vorbis specification documents
31
32 WHAT IS VORBIS:
33
34 Vorbis is a general purpose audio and music encoding format
35 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
36 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
37 proprietary formats such as RealAudio G2 and Windows' flavor of the
38 month), the Vorbis CODEC specification belongs to the public domain.
39 All the technical details are published and documented, and any
40 software entity may make full use of the format without royalty or
41 patent concerns.
42
43 This package contains libvorbis, a GPLed software implementation of
44 the Vorbis specification by the Xiphophorus company (http://www.xiph.org/).
45
46 CONTACT:
47
48 The OggSquish homepage is located at 'http://www.xiph.org/OggSquish'.
49 Vorbis's homepage is located at 'http://www.xiph.org/OggSquish/vorbis.html'.
50 Up to date technical documents, contact information, source code and
51 pre-built utilities may be found there.
52
53 BUILD:
54
55 A standard build should consist of nothing more than:
56
57 ./configure
58 ./make 
59
60 and as root if desired :
61
62 ./make install
63
64 This will install the ogg vorbis commandline encoder/player ('ogg')
65 into /usr/local/bin, the ogg player and libvorbis manpages into
66 /usr/local/man/ and libvorbis.a into /usr/local/lib.
67
68 Monty <monty@xiph.org>, <xiphmont@mit.edu>
69
70 $Id: README,v 1.1 1999/07/13 06:50:34 mwhitson Exp $