ObjectiveLib Build Instructions

# System Requirements

- Macintosh OS X version 10.3.5 or later or GNUstep base version 1.3.0 or later. These are the systems on which ObjectiveLib was developed. If you discover that it works on other systems, please contact the ObjectiveLib project. Note: Any non-Macintosh platform (any platform without the Cocoa Foundation framework) requires GNUstep.
- The GNU version of `make` is required.
- To build with the Cocoa Foundation framework on Macintosh, the command-line tool `xcodebuild` is required.
- On Windows GNUstep with MinGW the pthread library and the libgw32c library from the gnuwin32 package are required.
- To build the documentation you must have doxygen.
- To make the class diagrams in the documentation be cool instead of just okay, you must have the graphviz graph visualization tool which is available for Macintosh OS X from the fink project and also at pixelglow.

# Building ObjectiveLib

1. Unpack the source archive to a directory of your choosing.
2. Enter that directory and run the configure script: `./configure`. Note that there are various options that may help when you run the configure script. You can see all available options by running `./configure --help`. Here is a list of options related to ObjectiveLib:
   `--with-xcodebuild=PATH`
     For a non-GNUstep build only, the specific path to the `xcodebuild` tool.
   `--with-doxygen=PATH`
     The specific path to the doxygen executable.
   `--with-dot=PATH`
     The specific path to the dot tool, which is part of the graphviz graph visualization package. The dot tool is only used if you build the documentation.
   `--with-fwk-dir=PATH`
     For a non-GNUstep build only, the directory where you would like the framework to be installed. By default this is `${HOME}/Library/Frameworks`.
   `--with-doc-dir=PATH`
     The directory where you would like the documentation to be installed. By default this is `${HOME}/Documents`.
   `--with-gnustep`
     This option will force the use of the GNUstep build even if a Macintosh operating system is detected.
   `--with-zlib`
     Check for the presence of the zlib compression library. The default is yes.
   `--with-bzlib`
     Check for the presence of the bzlib compression library. The default is yes.
   None of these options is required, as the configure script will set reasonable defaults for all options.
3. Run `make` to build the framework. Alternatively, you may run `make run-tests` to build the framework and the unit tests and to run the tests. For a complete list of make targets when not building with GNUstep run `make help`.
4. If you have doxygen installed and the configure script was able to find it, you may build the documentation with `make doc`. If you don't have doxygen, then `make doc` does nothing.
5. Finally, when you are ready to install ObjectiveLib run `make install`. This copies the framework and the documentation, if available, to the directories chosen when the configure script was run.

# Platform Notes

ObjectiveLib has been built and tested on the following platforms:

#### Power PC

Macintosh OS X 10.3.5 (and later, though still untested on 10.4.x)

#### Intel x86

Windows: MinGW 3.1.0
Windows: Cygwin 1.5.17-1
Linux: Red Hat Fedora
Linux: Slackware 10.0
Linux: Debian Woody
FreeBSD 5.3
NetBSD 1.6.2
Sun Solaris 9

#### Sparc

Sun Solaris 9
Note that when building with versions of GNUstep that predate the introduction of keyed archives you will receive many warnings relating to keyed archives. Don't worry. ObjectiveLib will build and operate just fine in this environment.

$Id: Build.html,v 1.10 2005/07/13 20:02:39 will_mason Exp $