======================================================================
Requirements
======================================================================


Operating System
----------------

Ice is expected to build and run properly on any recent Mac OS X
version. However, Ice is officially supported only on Mac OS X 10.4.x.


C++ compiler
------------

Ice is expected to build properly with GCC 3.3 or later. However, only
the GCC 4.0.1 compiler is officially supported on Mac OS X 10.4.x.


Third-party libraries
---------------------

Ice has dependencies on a number of third-party libraries:

- Berkeley DB 4.5.20 configured with --enable-cxx.

  If you intend to use Ice for Java with Berkeley DB, you must also
  include the option --enable-java.

  You can download the Berkeley DB source distribution from

  http://www.oracle.com/technology/software/products/berkeley-db/index.html

- expat 2.0. You can download expat from

  http://sourceforge.net/projects/expat/

- mcpp 2.6.4, which can be downloaded from

  http://mcpp.sourceforge.net/download.html

  After downloading and unpacking the source distribution it is 
  necessary to first apply a source patch available on the Ice
  download page before building. From the mcpp 2.6.4 base directory
  run

  patch -p0 < mcpp-2.6.4.patch

  Ice requires the library version of mcpp, so configure mcpp similar
  to the following

  ./configure --enable-mcpplib --enable-shared
  (and --prefix=<dir> if you like)

======================================================================
Compilation and Testing
======================================================================

Extract the Ice archive in any directory you like (for example, in
your home directory):

$ tar xvfz Ice-@ver@.tar.gz

Change the working directory to Ice-@ver@:

$ cd Ice-@ver@

Edit config/Make.rules to establish your build configuration. The
comments in the file provide more information. Pay particular
attention to the variables that define the locations of the third-
party libraries.

Now you're ready to build Ice:

$ make

This will build the Ice core libraries, services, tests and examples.
After a successful build, you can run the test suite, provided that
you have installed Python:

$ make test

This is equivalent to:

$ python allTests.py

If everything worked out, you should see lots of "ok" messages. In
case of a failure, the tests abort with "failed".

If you want to try out any of the demos, make sure to update your PATH
environment variable to add the "bin" directory, and your
DYLD_LIBRARY_PATH environment variable to add the "lib" directory:

$ export PATH=`pwd`/bin:$PATH
$ export DYLD_LIBRARY_PATH=`pwd`/lib:$DYLD_LIBRARY_PATH

On Intel platforms, you also need to set DYLD_BIND_AT_LAUNCH to
prevent random crashes at runtime in the dynamic linker binding code:

$ export DYLD_BIND_AT_LAUNCH=1


======================================================================
Installation
======================================================================

Simply run "make install". This will install Ice in the directory
specified by the "prefix" variable in config/Make.rules.

After installation, make sure that the <prefix>/bin directory is in
your PATH, and the <prefix>/lib directory is in your
DYLD_LIBRARY_PATH. When compiling Ice programs, you must pass the
location of the <prefix>/include directory to the compiler with the -I
option, and the location of the <prefix>/lib directory with the -L
option.