fix: only do ogg-flac seeking tests if flac has ogg support built in

[platform/upstream/flac.git] / README

diff --git a/README b/README
index 63e6c05..a45a6f4 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 /* FLAC - Free Lossless Audio Codec
- * Copyright (C) 2001,2002,2003  Josh Coalson
+ * Copyright (C) 2001,2002,2003,2004,2005  Josh Coalson
  *
  * This file is part the FLAC project.  FLAC is comprised of several
  * components distributed under difference licenses.  The codec libraries
@@ -40,10 +40,11 @@ Documentation License (see COPYING.FDL).
 
 
 ===============================================================================
-FLAC - 1.1.0 - Contents
+FLAC - 1.1.1 - Contents
 ===============================================================================
 
 - Introduction
+- Prerequisites
 - Building in a GNU environment
 - Building with Makefile.lite
 - Building with MSVC
@@ -57,7 +58,7 @@ Introduction
 
 This is the source release for the FLAC project.  See
 
-       doc/index.html
+       doc/html/index.html
 
 for full documentation.
 
@@ -72,6 +73,19 @@ A brief description of the directory tree:
 
 
 ===============================================================================
+Prerequisites
+===============================================================================
+
+To build FLAC with support for Ogg FLAC you must have built and installed
+libogg according to the specific instructions below.  You must have
+libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.
+
+If you are building on x86 and want the assembly optimizations, you will
+need to have NASM >= 0.98.30 installed according to the specific instructions
+below.
+
+
+===============================================================================
 Building in a GNU environment
 ===============================================================================
 
@@ -120,7 +134,6 @@ $HOME/.xmms/Plugins, instead of the global XMMS plugin area
 (usually /usr/lib/xmms/Input).
 
 --with-ogg=
---with-id3lib=
 --with-xmms-prefix=
 --with-libiconv-prefix=
 Use these if you have these packages but configure can't find them.
@@ -162,10 +175,9 @@ all the libraries and executables.
 Prerequisite: you must have the Ogg libraries installed as described
 later.
 
-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
+Prerequisite: you must have nasm installed, and nasmw.exe must be in
+your PATH, or the path to nasmw.exe must be added to the list of
+directories for executable files in the MSVC global options.
 
 To build everything, run Developer Studio, do File|Open Workspace,
 and open FLAC.dsw.  Select "Build | Set active configuration..."
@@ -178,8 +190,7 @@ binaries, statically linked (e.g. obj\release\bin\flac.exe).
 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 and
 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.
+place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins.
 
 By default the code is configured with Ogg support.  Before building FLAC
 you will need to get the Ogg source distribution
@@ -206,6 +217,15 @@ This will create everything and leave it in the build/ directory.
 Don't worry about the rest of the stuff that is in build/ or
 the stuff that was already there before building.
 
+The Project Builder project requires that you have libiconv and
+libogg in /sw, ala fink.  If you don't, you'll need to install
+them somewhere and change the path to them in the Library Paths
+section of several targets.
+
+It also assumes the CPU supports Altivec instructions.  If it does
+not, you will also have to add -DFLAC__NO_ASM to the CFLAGS in the
+libFLAC target.
+
 There currently is no install procedure; you will have to
 manually copy the tools to wherever you need them.