[xiph-cvs] cvs commit: vorbis-tools README

[Stan Seibert]

volsung     02/06/03 06:22:41

  Modified:    .        README
  Log:
  Update the explanations in this file.  Closes bug #109.

Revision  Changes    Path
1.4       +26 -11    vorbis-tools/README

Index: README
===================================================================
RCS file: /usr/local/cvsroot/vorbis-tools/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README	2000/11/08 08:46:48	1.3
+++ README	2002/06/03 13:22:40	1.4
@@ -4,16 +4,32 @@
 modules (eg, the modules vorbis, vorbis-tools and vorbis-plugins for the 
 Vorbis codec) contain the codec libraries for use with Ogg bitstreams.
 
-Directory:
+DIRECTORIES:
 
-./oggenc  	the ogg vorbis encoder
+debian/		debian packaging stuff
+include/	header files shared between the tools
+intl/		GNU gettext library from gettext-0.10.40 (for i18n support)
+ogg123/		an ogg vorbis commandline audio player
+oggenc/		the ogg vorbis encoder
+ogginfo/	provides information (tags, bitrate, length, etc.) about 
+		an ogg vorbis file
+po/		translations for non-English languages
+share/		code shared between the tools
+vcut/		cuts an ogg vorbis file into two parts at a particular point
+vorbiscomment/	edits the comments in an ogg vorbis file
+win32/		Win32 build stuff
+
+DEPENDENCIES:
+
+All of the tools require libogg and libvorbis to be installed (along
+with the header files).  Additionally, ogg123 requires libao and
+libcurl.  The libraries libogg, libvorbis, and libao are all available at
+  http://www.vorbis.com/download.psp
+
+The libcurl library is packaged with most Linux distributions.  The
+source code can also be downloaded from:
+  http://curl.haxx.se/libcurl/
 
-./ogg123	an ogg vorbis commandline audio player
-
-./vorbiscomment a comment editor
-
-./debian	debian packaging stuff
-
 CONTACT:
 
 The Ogg Vorbis homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
@@ -29,9 +45,8 @@
 
 make install
 
-This will install the Ogg libraries (static and shared) into
-/usr/local/lib, includes into /usr/local/include and API manpages
-(once we write some) into /usr/local/man.
+This will install the tools into /usr/local/bin and API manpages
+into /usr/local/man.
 
 BUILDING FROM TARBALL DISTRIBUTIONS:
 

<p><p><p>--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.