Blame README

Packit 0d464f
ABOUT THE OPENEXR LIBRARIES
Packit 0d464f
----------------------------
Packit 0d464f
Packit 0d464f
IlmImf is our "EXR" file format for storing 16-bit FP images.  Libraries in
Packit 0d464f
this package depend on the IlmBase library.
Packit 0d464f
Packit 0d464f
See the IlmImfExamples directory for some code that demonstrates how
Packit 0d464f
to use the IlmImf library to read and write OpenEXR files.  The doc
Packit 0d464f
directory contains some high-level documentation and history about the
Packit 0d464f
OpenEXR format.
Packit 0d464f
Packit 0d464f
If you have questions about using the OpenEXR libraries, you may want
Packit 0d464f
to join our developer mailing list.  See http://www.openexr.com for
Packit 0d464f
details.
Packit 0d464f
Packit 0d464f
Packit 0d464f
LICENSE
Packit 0d464f
-------
Packit 0d464f
Packit 0d464f
The OpenEXR source code distribution is free software.  See the file
Packit 0d464f
named COPYING (included in this distribution) for details.
Packit 0d464f
Packit 0d464f
Packit 0d464f
BUILDING OPENEXR
Packit 0d464f
----------------
Packit 0d464f
Packit 0d464f
Building OpenEXR requires the IlmBase and the zlib library.
Packit 0d464f
Packit 0d464f
You can obtain the source code for zlib from:
Packit 0d464f
Packit 0d464f
   http://www.zlib.net
Packit 0d464f
Packit 0d464f
If you're building OpenEXR on a Windows platform, see README.win32 for
Packit 0d464f
instructions on how to build OpenEXR.  The remainder of this file
Packit 0d464f
applies only to GNU/Linux or other UNIX-like systems.
Packit 0d464f
Packit 0d464f
After installing the required libraries, to build OpenEXR on
Packit 0d464f
GNU/Linux or other UNIX-like systems, do this:
Packit 0d464f
Packit 0d464f
./configure
Packit 0d464f
make
Packit 0d464f
make install
Packit 0d464f
Packit 0d464f
unless you obtained IlmBase directly from git, in which case you
Packit 0d464f
should first read README.git
Packit 0d464f
Packit 0d464f
Packit 0d464f
Please type :
Packit 0d464f
Packit 0d464f
./configure --help
Packit 0d464f
Packit 0d464f
for a list of options in relation to building IlmBase libraries. In 
Packit 0d464f
particular, peruse README.namespaces for information regarding the 
Packit 0d464f
use of namespaces in IlmBase and OpenEXR.
Packit 0d464f
Packit 0d464f
See README.OSX for details on building OpenEXR in MacOS X.
Packit 0d464f
Packit 0d464f
Do `make check` to run the OpenEXR confidence tests.  They should all
Packit 0d464f
pass; if you find a test that does not pass on your system, please let
Packit 0d464f
us know.
Packit 0d464f
Packit 0d464f
Other UNIX variants haven't been tested, but should be easy to build.
Packit 0d464f
Let us know if you're having problems porting OpenEXR to a particular
Packit 0d464f
platform.
Packit 0d464f
Packit 0d464f
All include files needed to use the OpenEXR libraries are installed in the 
Packit 0d464f
OpenEXR subdirectory of the install prefix, e.g. /usr/local/include/OpenEXR.
Packit 0d464f
Packit 0d464f
Packit 0d464f
USING OPENEXR IN YOUR APPLICATIONS
Packit 0d464f
----------------------------------
Packit 0d464f
Packit 0d464f
On systems with support for pkg-config, use `pkg-config --cflags
Packit 0d464f
OpenEXR` for the C++ flags required to compile against OpenEXR
Packit 0d464f
headers; and `pkg-config --libs OpenEXR` for the linker flags required
Packit 0d464f
to link against OpenEXR libraries.
Packit 0d464f