update version number to 1.0.1; minor cosmetics with Ogg defines
[flac.git] / README
diff --git a/README b/README
index 07a4c5c..d8a7f68 100644 (file)
--- a/README
+++ b/README
@@ -29,9 +29,9 @@ FLAC metadata, licensed under the GPL; 4) player plugins for XMMS
 and Winamp, licensed under the GPL; and 5) documentation, licensed
 under the GNU Free Documentation License.
 
-===========
-FLAC - 0.10
-===========
+==========
+FLAC - 1.0
+==========
 
 This is the source release for the FLAC project.  See
 
@@ -51,14 +51,57 @@ A brief description of the directory tree:
 Building in a GNU environment
 =============================
 
-FLAC now uses autoconf and libtool for configuring and
-building.  Better documentation for these will be
-forthcoming, but in general, this should work:
+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 install
 
-To disable all assembly optimizations, pass the
---disable-asm-optimizations flag to configure.
+If it doesn't, see the next section on Makefile.lite.
+
+There are a few FLAC-specific arguments you can give to
+`configure':
+
+--enable-debug : Builds everything with debug symbols and some
+extra (and more verbose) error checking.
+
+--disable-asm-optimizations : Disables the compilation of the
+assembly routines.  Many routines have assembly versions for
+speed and `configure' is pretty good about knowing what is
+supported, but you can use this option to build only from the
+C sources.
+
+--sse-os : If you are building for an x86 CPU that supports
+SSE instructions, you can enable some of the faster routines
+if your operating system also supports SSE instructions.  flac
+can tell if the CPU supports the instructions but currently has
+no way to test if the OS does, so if it does, you must pass
+this argument to configure to use the SSE routines.  If flac
+crashes when built with this option you will have to go back and
+configure without --sse-os.  Note that --disable-asm-optimizations
+overrides --sse-os.
+
+
+===========================
+Building with Makefile.lite
+===========================
+
+There is a more lightweight build system for do-it-yourself-ers.
+It is also useful if configure isn't working, which may be the
+case since lately we've had some problems with different versions
+of automake and libtool.  The Makefile.lite system should work
+on Gnu systems with few or no minor adjustments.
+
+From the top level just 'make -f Makefile.lite'.  You can
+specify zero or one optional target from 'release', 'debug',
+'test', or 'clean'.  The default is 'release'.  There is no
+'install' target but everything you need will end up in the
+obj/ directory.
+
+If you are not on an x86 system or you don't have nasm, you
+may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
+you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
+not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 
 
 ==================
@@ -72,3 +115,22 @@ 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 .s files.
+
+
+====================
+Building on Mac OS X
+====================
+
+There is a Project Builder project in the top-level source
+directory to build libFLAC and the command-line utilities on
+Mac OS X.  In a terminal, cd to the top-level directory (the
+one that contains this README file) and type:
+
+       pbxbuild -alltargets
+
+This will create everything and leave it in build/ directory.
+Don't worry about the rest of the stuff that is in build or
+the stuff that was already there before building.
+
+There currently is no install procedure; you will have to
+manually copy the tools to wherever you need them.