Blame README

Packit 8dc392
ABOUT THE ILMBASE LIBRARIES 
Packit 8dc392
----------------------------
Packit 8dc392
Packit 8dc392
Half is a class that encapsulates our 16-bit floating-point format.
Packit 8dc392
Packit 8dc392
IlmThread is a thread abstraction library for use with OpenEXR
Packit 8dc392
and other software packages.  It currently supports pthreads and
Packit 8dc392
Windows threads.
Packit 8dc392
Packit 8dc392
Imath implements 2D and 3D vectors, 3x3 and 4x4 matrices, quaternions
Packit 8dc392
and other useful 2D and 3D math functions.
Packit 8dc392
Packit 8dc392
Iex is an exception-handling library.
Packit 8dc392
Packit 8dc392
If you have questions about using the IlmBase libraries, you may want
Packit 8dc392
to join our developer mailing list.  See http://www.openexr.com for
Packit 8dc392
details.
Packit 8dc392
Packit 8dc392
Packit 8dc392
LICENSE
Packit 8dc392
-------
Packit 8dc392
Packit 8dc392
The IlmBase source code distribution is free software.  See the file
Packit 8dc392
named COPYING (included in this distribution) for details.
Packit 8dc392
Packit 8dc392
Packit 8dc392
BUILDING ILMBASE
Packit 8dc392
----------------
Packit 8dc392
Packit 8dc392
To build IlmBase on GNU/Linux or other UNIX-like systems, do this:
Packit 8dc392
Packit 8dc392
./configure
Packit 8dc392
make
Packit 8dc392
make install
Packit 8dc392
Packit 8dc392
unless you obtained IlmBase directly from git, in which case you
Packit 8dc392
should first read README.git
Packit 8dc392
Packit 8dc392
Packit 8dc392
Please type :
Packit 8dc392
Packit 8dc392
./configure --help
Packit 8dc392
Packit 8dc392
for a list of options in relation to building IlmBase libraries. In 
Packit 8dc392
particular, peruse README.namespaces for information regarding the 
Packit 8dc392
use of namespaces in IlmBase and OpenEXR.
Packit 8dc392
Packit 8dc392
Packit 8dc392
See README.OSX for details on building IlmBase in MacOS X.
Packit 8dc392
Packit 8dc392
Do `make check` to run the IlmBase confidence tests.  They should all
Packit 8dc392
pass; if you find a test that does not pass on your system, please let
Packit 8dc392
us know.
Packit 8dc392
Packit 8dc392
Other UNIX variants haven't been tested, but should be easy to build.
Packit 8dc392
Let us know if you're having problems porting IlmBase to a particular
Packit 8dc392
platform.
Packit 8dc392
Packit 8dc392
All include files needed to use the IlmBase libraries are installed in the 
Packit 8dc392
OpenEXR subdirectory of the install prefix, e.g. /usr/local/include/OpenEXR.
Packit 8dc392
Packit 8dc392
Packit 8dc392
USING ILMBASE IN YOUR APPLICATIONS
Packit 8dc392
----------------------------------
Packit 8dc392
Packit 8dc392
On systems with support for pkg-config, use `pkg-config --cflags
Packit 8dc392
IlmBase` for the C++ flags required to compile against IlmBase
Packit 8dc392
headers; and `pkg-config --libs IlmBase` for the linker flags required
Packit 8dc392
to link against IlmBase libraries.
Packit 8dc392