new grabbag testers

[platform/upstream/flac.git] / README

diff --git a/README b/README
index 4cb21d9..2b7a4d5 100644 (file)
--- a/README
+++ b/README
@@ -22,18 +22,24 @@ codec developed by Josh Coalson.
 
 FLAC is comprised of
   * `libFLAC', a library which implements reference encoders and
-    decoders, and a metadata interface, licensed under the GNU
-    Lesser General Public License (LGPL)
+    decoders, and a metadata interface
   * `libFLAC++', a C++ object wrapper library around libFLAC
-  * `flac', a command-line program for encoding and decoding files,
-    licensed under the GNU General public License (GPL)
-  * `metaflac', a command-line program for editing FLAC metadata,
-    licensed under the GPL
-  * player plugins for XMMS and Winamp, licensed under the GPL
-  * documentation, licensed under the GNU Free Documentation License.
+  * `libOggFLAC' and `libOggFLAC++', which provide encoders and
+    decoders for FLAC streams in an Ogg container
+  * `flac', a command-line program for encoding and decoding files
+  * `metaflac', a command-line program for editing FLAC metadata
+  * player plugins for XMMS and Winamp
+  * user and API documentation
+
+The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
+licensed under the GNU Lesser General Public License (LGPL).  All other
+programs and plugins are licensed under the GNU General Public License
+(GPL).  The documentation is licensed under the GNU Free Documentation
+License (GFDL).
+
 
 ===============================================================================
-FLAC - 1.0.3 - Contents
+FLAC - 1.0.4 - Contents
 ===============================================================================
 
 - Introduction
@@ -72,7 +78,10 @@ FLAC uses autoconf and libtool for configuring and building.
 Better documentation for these will be forthcoming, but in
 general, this should work:
 
-./configure && make && make install
+./configure && make && make check && make install
+
+The 'make check' step is optional; omit it to skip all the tests,
+which can take several hours.
 
 NOTE: Despite our best efforts it's entirely possible to have
 problems when using older versions of autoconf, automake, or
@@ -108,6 +117,12 @@ they may cause flac to crash, which is why it is not turned on
 by default.  Note that --disable-asm-optimizations overrides
 --enable-3dnow.
 
+--with-ogg=
+--with-id3lib=
+--with-xmms-prefix=
+--with-libiconv-prefix=
+Use these if you have these packages but configure can't find them.
+
 
 ===============================================================================
 Building with Makefile.lite
@@ -135,13 +150,49 @@ not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 Building with MSVC
 ===============================================================================
 
-There is no overall make system for MSVC but the individual
-source directories with a 'Makefile.vc' file in them allow
-building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
-the Makefile.vc for libFLAC is hardcoded to use nasm.  If
-you don't have nasm, or don't want any assembly optimizations,
-edit the makefile, adding '/D FLAC__NO_ASM', and delete the
-rules which compile the .nasm files.
+There are two ways to build with MSVC:
+@@@@Prerequisite: Ogg headers/libs
+
+  1. Project Files
+  ----------------
+  Prerequisite: you must have nasm installed, and have the environment
+  variable FLAC_NASM set to the full path to nasmw.exe, e.g
+
+    C:\nasm\nasmw.exe
+
+  To build everything, run Developer Studio, do File|Open Workspace,
+  and open FLAC.dsw.  Switch to the 'Files' tab, select 'all files'
+  from the tree, do right-mouse-button and 'Set as active project'.
+  The default build mode will probably be Debug; to change to release
+  do Build|Set Active Configuration and select 'all - Win32 Release'.
+  Then do Project|Build.  The libraries will be built as and DLLs and
+  you'll need to install these as well.
+
+  2. nmake
+  --------
+  Prerequisite: you must have nasm installed and nasmw.exe must be in
+  your path.
+
+  To build everything, open a Command window, cd to the top-level
+  directory (where this README is) and do
+
+    nmake /f Makefile.vc
+
+  This will recur into all the source directories in the right order
+  and build everything.  The libraries will be build only as static
+  libs.  You need only to install the binaries.  To clean up everything
+  you can do
+
+    nmake /f Makefile.vc clean
+
+  from the top level directory, or any directory which has a
+  Makefile.vc
+
+Everything will end up in the 'obj' directory.  DLLs and .exe files
+are all that are needed and can be copied to an installation area an
+added to the PATH.  The plugins have to be copied to their appropriate
+place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
+and for Winamp3 this is <winamp3-dir>\Wacs.
 
 
 ===============================================================================