merged libpng 1.5.7 to trunk

[wxWidgets.git] / src / png / INSTALL

diff --git a/src/png/INSTALL b/src/png/INSTALL
index 4978740993f304546b2aaea6c5d54bed1bdce53a..e6979c6fb01656c5cf73c252cafb9bc91a71e536 100644 (file)
--- a/src/png/INSTALL
+++ b/src/png/INSTALL
@@ -1,17 +1,59 @@
 
 

-Installing libpng version 1.0.1 March 15, 1998
+Installing libpng

 
 

-Before installing libpng, you must first install zlib.  zlib
-can usually be found wherever you got libpng.  zlib can be
-placed in another directory, at the same level as libpng.
-Note that your system might already have a preinstalled
-zlib, but you will still need to have access to the 
-zlib.h and zconf.h include files that correspond to the
-version of zlib that's installed.
+On Unix/Linux and similar systems, you can simply type
+
+    ./configure [--prefix=/path]
+    make check
+    make install
+
+and ignore the rest of this document.
+
+If configure does not work on your system and you have a reasonably
+up-to-date set of tools, running ./autogen.sh before running ./configure
+may fix the problem.  You can also run the individual commands in
+autogen.sh with the --force option, if supported by your version of
+the tools.  To be really sure that you aren't using any of the included
+pre-built scripts, you can do this:
+
+    ./configure --enable-maintainer-mode
+    make maintainer-clean
+    ./autogen.sh
+    ./configure [--prefix=/path] [other options]
+    make
+    make install
+    make check
+
+Instead, you can use one of the custom-built makefiles in the
+"scripts" directory
+
+    cp scripts/makefile.system makefile
+    make test
+    make install
+
+The files that are presently available in the scripts directory
+are listed and described in scripts/README.txt.
+
+Or you can use one of the "projects" in the "projects" directory.
+
+Before installing libpng, you must first install zlib, if it
+is not already on your system.  zlib can usually be found
+wherever you got libpng.  zlib can be placed in another directory,
+at the same level as libpng.
+
+If you want to use "cmake" (see www.cmake.org), type
+
+   cmake . -DCMAKE_INSTALL_PREFIX=/path
+   make
+   make install
+
+If your system already has a preinstalled zlib you will still need
+to have access to the zlib.h and zconf.h include files that
+correspond to the version of zlib that's installed.

 
 You can rename the directories that you downloaded (they
 
 You can rename the directories that you downloaded (they

-might be called "libpng-1.0.1 or "lpng100" and "zlib-1.1.1"
-or "zlib111") so that you have directories called "zlib" and "libpng".
+might be called "libpng-x.y.z" or "libpngNN" and "zlib-1.2.5"
+or "zlib125") so that you have directories called "zlib" and "libpng".

 
 Your directory structure should look like this:
 
 
 Your directory structure should look like this:
 


@@ -21,8 +63,25 @@ Your directory structure should look like this:
           README
           *.h
           *.c
           README
           *.h
           *.c

+          CMakeLists.txt    =>  "cmake" script
+          configuration files:
+             configure.ac, configure, Makefile.am, Makefile.in,
+             autogen.sh, config.guess, ltmain.sh, missing, libpng.pc.in,
+             libpng-config.in, aclocal.m4, config.h.in, config.sub,
+             depcomp, install-sh, mkinstalldirs, test-pngtest.sh
+          contrib
+             gregbook
+             pngminim
+             pngminus
+             pngsuite
+             visupng
+          projects
+             visualc71
+             vstudio

           scripts
              makefile.*
           scripts
              makefile.*

+             *.def (module definition files)
+             etc.

           pngtest.png
           etc.
       zlib
           pngtest.png
           etc.
       zlib


@@ -32,56 +91,65 @@ Your directory structure should look like this:
           contrib
           etc.
 
           contrib
           etc.
 

-First enter the zlib directory and follow the instructions
-in zlib/README.  Then come back here and choose the
-appropriate makefile.sys in the scripts directory.
-The files that are presently available in the scripts directory
-include
-
-      descrip.mms   =>  VMS makefile for MMS or MMK
-      makefile.std  =>  Generic UNIX makefile
-      makefile.knr  =>  Archaic UNIX Makefile that converts files with ansi2knr
-      makefile.dec  =>  DEC Alpha UNIX makefile
-      makefile.sgi  =>  Silicon Graphics IRIX makefile
-      makefile.sun  =>  Sun makefile
-      makefile.s2x  =>  Solaris 2.X makefile (gcc, creates libpng.so.2.1.0)
-      makefile.lnx  =>  Linux/ELF makefile (gcc, creates libpng.so.2.1.0)
-      makefile.mip  =>  MIPS makefile
-      makefile.aco  =>  Acorn makefile
-      makefile.ama  =>  Amiga makefile
-      smakefile.ppc =>  AMIGA smakefile for SAS C V6.58/7.00 PPC compiler
-                        (Requires SCOPTIONS, copied from scripts/SCOPTIONS.ppc)
-      makefile.atr  =>  Atari makefile
-      makefile.bor  =>  Borland makefile
-      build.bat     =>  MS-DOS batch file for Borland compiler
-      makefile.dj2  =>  DJGPP 2 makefile
-      makefile.msc  =>  Microsoft C makefile
-      makefile.tc3  =>  Turbo C 3.0 makefile
-      makefile.os2  =>  OS/2 Makefile (gcc and emx, requires pngos2.def)
-      pngos2.def    =>  OS/2 module definition file used by makefile.os2
-      makefile.wat  =>  Watcom 10a+ Makefile, 32-bit flat memory model
-      makevms.com   =>  VMS build script
+If the line endings in the files look funny, you may wish to get the other
+distribution of libpng.  It is available in both tar.gz (UNIX style line
+endings) and zip (DOS style line endings) formats.
+
+If you are building libpng with MSVC, you can enter the
+libpng projects\visualc6 or visualc71 directory and follow the instructions
+in README.txt.
+
+Otherwise enter the zlib directory and follow the instructions in zlib/README,
+then come back here and run "configure" or choose the appropriate
+makefile.sys in the scripts directory.

 
 Copy the file (or files) that you need from the
 scripts directory into this directory, for example
 
 
 Copy the file (or files) that you need from the
 scripts directory into this directory, for example
 

-   MSDOS example: copy scripts\makefile.msd makefile
+   MSDOS example: copy scripts\makefile.msc makefile

    UNIX example:    cp scripts/makefile.std makefile
 
 Read the makefile to see if you need to change any source or
 target directories to match your preferences.
 
    UNIX example:    cp scripts/makefile.std makefile
 
 Read the makefile to see if you need to change any source or
 target directories to match your preferences.
 

-Then read pngconf.h to see if you want to make any configuration
+Then read pnglibconf.dfa to see if you want to make any configuration

 changes.
 
 changes.
 

-Then just run "make test" which will create the libpng library in
-this directory and run a quick test that reads the "pngtest.png"
-file and writes a "pngout.png" file that should be identical to it.
+Then just run "make" which will create the libpng library in
+this directory and "make test" which will run a quick test that reads
+the "pngtest.png" file and writes a "pngout.png" file that should be
+identical to it.  Look for "9782 zero samples" in the output of the
+test.  For more confidence, you can run another test by typing
+"pngtest pngnow.png" and looking for "289 zero samples" in the output.
+Also, you can run "pngtest -m contrib/pngsuite/*.png" and compare
+your output with the result shown in contrib/pngsuite/README.

 
 Most of the makefiles will allow you to run "make install" to
 put the library in its final resting place (if you want to
 do that, run "make install" in the zlib directory first if necessary).
 
 Most of the makefiles will allow you to run "make install" to
 put the library in its final resting place (if you want to
 do that, run "make install" in the zlib directory first if necessary).

+Some also allow you to run "make test-installed" after you have
+run "make install".
+
+Further information can be found in the README and libpng-manual.txt
+files, in the individual makefiles, in png.h, and the manual pages
+libpng.3 and png.5.
+
+Using the ./configure script -- 16 December 2002.
+=================================================
+
+The ./configure script should work compatibly with what scripts/makefile.*
+did, however there are some options you might need to add to configure
+explicitly, which previously was done semi-automatically (if you didn't edit
+scripts/makefile.* yourself, that is)
+
+CFLAGS="-Wall -O -funroll-loops \
+-malign-loops=2 -malign-functions=2" ./configure --prefix=/usr/include \
+--with-pkgconfigdir=/usr/lib/pkgconfig --includedir=/usr/include
+
+You can alternatively specify --includedir=/usr/include, /usr/local/include,
+/usr/include/libpng%NN%, or whatever.
+
+If you find that the configure script is out-of-date or is not supporting
+your platform properly, try running autogen.sh to regenerate "configure",
+"Makefile.in", and the other configuration files. Then try configure again.

 
 

-Further information can be found in the README and libpng.txt
-files, in the individual makefiles, and in png.h, and the manual
-pages libpng.3 and png.5.