X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=INSTALL;h=144d0c7772860012fe39b8db39917c46185b639a;hb=958c615a835efb8bddce05e187a3a1344371ba69;hp=a3d97475257933d36b083e679ee0f775fe970c07;hpb=27b894dd3fd6d67dacf6c263587d789d96172116;p=openjpeg.git

diff --git a/INSTALL b/INSTALL
index a3d97475..144d0c77 100644
--- a/INSTALL
+++ b/INSTALL
@@ -5,7 +5,11 @@ How to build and install openjpeg binaries
 UNIX/LINUX similar systems
 --------------------------
 
-1) Using configure tools
+1) Using autotools
+
+It is highly recommended that pkg-config is installed. If needed, you have to
+properly set the environment variable PKG_CONFIG_PATH so that the .pc files
+are found.
 
 To build from top-level directory, you can simply type: 
   ./bootstrap.sh
@@ -33,12 +37,26 @@ To build doc (requires 'doxygen' to be found on your system):
 Main './configure' options (type './configure --help' for more details)
   '--enable-mj2'
   '--enable-jpwl'
+  '--enable-jpip'
   '--prefix=/path/to/install/directory' (example : '--prefix=$PWD/installed')
   '--enable-debug' (default : disabled)
 
 You can also specify your own CFLAGS and LDFLAGS with (for example):
   CFLAGS="-O3 -pipe" LDFLAGS="-Wl,-s" ./configure
 
+The (optional) dependencies of some binaries are libpng, libtiff, libcms 1 or 2
+and FastCGI. Only libtiff and FastCGI have no .pc file. There should be some
+automatic detection if they are installed in /usr, /usr/local or /opt/local.
+Otherwise, you can tune their detection (as well as for libpng and libcms1 or 2
+too) with the environment variables:
+
+TIFF_CFLAGS
+TIFF_LIBS
+FCGI_CFLAGS
+FCGI_LIBS
+
+See './configure --help' output for more details.
+
 
 2) Using cmake (see www.cmake.org)
 
@@ -48,12 +66,13 @@ Type:
 
 If you are root:
   make install
-  make clean
 
-else:
+else if you have sudo power:
   sudo make install
-  make clean
-  
+
+else
+  DESTDIR=$HOME/local make install
+
 To build the Doxygen documentation (Doxygen needs to be found on the system):
 (A 'html' directory is generated in the 'doc' directory)
   make doc
@@ -61,31 +80,21 @@ To build the Doxygen documentation (Doxygen needs to be found on the system):
 Binaries are located in the 'bin' directory.
 
 Main available cmake flags:
-* To specify the install path: '-DCMAKE_INSTALL_PREFIX=/path'
+* To specify the install path: '-DCMAKE_INSTALL_PREFIX=/path', or use DESTDIR env variable (see above)
 * To build the shared libraries and links the executables against it: '-DBUILD_SHARED_LIBS:bool=on' (default: 'ON')
   Note: when using this option, static libraries are not built and executables are dynamically linked.
 * To build the CODEC executables: '-DBUILD_CODEC:bool=on' (default: 'ON')
 * To build the MJ2 executables: '-DBUILD_MJ2:bool=on' (default: 'OFF')
 * To build the JPWL executables and JPWL library: '-DBUILD_JPWL:bool=on' (default: 'OFF')
-* [WIN32 ONLY] To build the INDEXER_JPIP executable: '-DBUILD_INDEXER_JPIP:bool=on' (default: 'OFF')
+* To build the JPIP library and utilities: '-DBUILD_JPIP:bool=on' (default: 'OFF')
 * To enable testing (and automatic result upload to http://my.cdash.org/index.php?project=OPENJPEG):
-    cmake . -DBUILD_TESTING:BOOL=ON -DJPEG2000_CONFORMANCE_DATA_ROOT:PATH=/path/to/your/JPEG2000/test/files
+    cmake . -DBUILD_TESTING:BOOL=ON -DOPJ_DATA_ROOT:PATH='path/to/the/data/directory'
     make
     make Experimental
-  Note : JPEG2000 test files are available here : http://www.crc.ricoh.com/~gormish/jpeg2000conformance/
-
-3) Manually using Makefile.nix:
-- Manually edit the config.nix file
-- Manually create an opj_config.h file from opj_config.h.in.user
-  and edit this opj_config.h
-- Then : (if 'WITH_JPWL' is defined in config.nix)
-    make -f Makefile.nix all
-    make -f Makefile.nix install
-    make -f Makefile.nix clean
-    make -f Makefile.nix uninstall
-- If 'WITH_JPWL' is not defined in config.nix
-  and you want to clean/compile/install/uninstall JPWL:
-  call the respective target in the respective directory.
+  Note : JPEG2000 test files are available with 'svn checkout http://openjpeg.googlecode.com/svn/data' (about 70 Mo).
+  If '-DOPJ_DATA_ROOT:PATH' option is omitted, test files will be automatically searched in '${CMAKE_SOURCE_DIR}/../data',
+  corresponding to the location of the data directory when compiling from the trunk (and assuming the data directory has
+  been checked out of course).
 
 MACOSX
 ------
@@ -99,7 +108,7 @@ If it does not work, try adding the following flag to the cmake command :
 WINDOWS
 -------
 
-If you're using cygwin or MinGW, the same procedures as for Unix can be used. 
+If you're using cygwin or MinGW+MSYS, the same procedures as for Unix can be used. 
 
 Otherwise you can use cmake to generate project files for the IDE you are using (VC2010, etc).
 Type 'cmake --help' for available generators on your platform.