INSTALL

   1
   2 How to build and install openjpeg binaries
   3 ==========================================
   4
   5 UNIX/LINUX similar systems
   6 --------------------------
   7
   8 1) Using configure tools
   9
  10 You can simply type
  11   ./configure [--prefix=/path]
  12   make
  13
  14 If you are root:
  15   make install
  16   make clean
  17   make distclean
  18
  19 else:
  20   sudo make install
  21   make clean
  22   make distclean
  23
  24 Binaries are located in the 'bin' directory.
  25
  26 If 'configure' does not work on your system please
  27 call './bootstrap.sh'.
  28
  29 If 'configure' does not find a library or header file,
  30 or to see available configure options, please try
  31 './configure --help'.
  32
  33 2) Using cmake (see www.cmake.org)
  34
  35 Type:
  36   cmake .
  37   make
  38
  39 If you are root:
  40   make install
  41   make clean
  42
  43 else:
  44   sudo make install
  45   make clean
  46
  47 Binaries are located in the 'bin' directory.
  48
  49 Main available cmake flags:
  50 * To specify the install path: '-DCMAKE_INSTALL_PREFIX=/path'
  51 * To build the shared libraries: '-DBUILD_SHARED_LIBS:bool=on'
  52 * To build the example codec: '-DBUILD_EXAMPLES:bool=on' (default is actually 'ON')
  53 * To build the JPWL binaries: '-DBUILD_JPWL:bool=on'
  54 * To build the JP3D binaries: '-DBUILD_JP3D:bool=on'
  55 * To build the doxygen documentation: '-DBUILD_DOCUMENTATION:bool=on'
  56 * To enable testing (and automatic result upload to http://my.cdash.org/index.php?project=OPENJPEG):
  57     cmake . -DBUILD_TESTING:BOOL=ON -DJPEG2000_CONFORMANCE_DATA_ROOT:PATH=/path/to/your/JPEG2000/test/files
  58     make
  59     make Experimental
  60   Note : JPEG2000 test files are available here : http://www.crc.ricoh.com/~gormish/jpeg2000conformance/
  61
  62 3) Manually using Makefile.nix:
  63 - Manually edit the config.nix file
  64 - Manually create an opj_config.h file from opj_config.h.in.user
  65   and edit this opj_config.h
  66 - Then : (if 'WITH_JPWL' and/or 'WITH_JP3D' are defined in config.nix)
  67     make -f Makefile.nix all
  68     make -f Makefile.nix install
  69     make -f Makefile.nix clean
  70     make -f Makefile.nix uninstall
  71 - If neither 'WITH_JPWL' nor 'WITH_JP3D' is defined in config.nix
  72   and you want to clean/compile/install/uninstall JPWL/JP3D:
  73   call the respective target in the respective directory.
  74
  75 MACOSX
  76 ------
  77
  78 The same building procedures as above will soon be available for MACOSX.
  79 The xcode project file has also to be updated.
  80 Right now, the CMake procedure is the only one working. Please refer to instructions above.
  81 If it does not work, try adding the following flag to the cmake command :
  82   '-DCMAKE_OSX_ARCHITECTURES:STRING=i386'
  83
  84 WINDOWS
  85 -------
  86
  87 If you're using cygwin, the same procedures as for Unix should work. Otherwise:
  88
  89 1) Using cmake to generate project files
  90
  91 Use the cmake procedure above with the '-G <generator-name>' flag to generate the project
  92 files for the IDE you are using. Type 'cmake --help' for available generators on your platform.
  93
  94 2) Using the provided project files
  95
  96 These files are obsolete and will be updated soon.