Copyright (c) 2003 Regents of The University of Michigan.
All Rights Reserved.  See COPYRIGHT.

------------------------------------------------
Quick instructions for install the radmind tools
------------------------------------------------

% ./configure
% make
% make install

--------------------------
More detailed instructions
--------------------------

1: Getting the source

Download the source from http://radmind.org/ and uncompress it into a
directory of your liking.  The current development source is also
available through an anonymous CVS server. See the "Building from CVS"
section below for more details.

2: Configure the software

Using configure in the top level directory, configure the software for
your system:

  % ./configure

The configure scripts take several options.  To see them, run:

  %s ./configure --help

3: Build and install the software

Now you are ready to build the software

  % make

Once that is done, you can install the tools.

  # make install

-------------------------------------
Building a Mac OS X Installer Package
-------------------------------------

The radmind Makefile contains a target called 'package', which will construct
a Mac OS X installer package suitable for distribution. To make the package,
login as an administrator and follow the steps below:

Enter the radmind source directory.
./configure
make package

During the build process, you will be prompted for your password.

PackageMaker currently does not work with make, so at the end of the build process you will see "make: *** [package] Error 2" even though that package was created successfully.

After the source has been built and the package created, you will be left with
a package called 'RadmindTools.pkg' in the parent directory of the radmind
source. This file may be double-clicked in the Finder to launch the Installer.

This target will fail if it is used on a system other than Mac OS X.

---------------------
Building for RedHat 9
---------------------
To build radmind on RedHat 9 with SSL support, you have give the location
for the kerberos header files:

  % "env CPPFLAGS=-I/usr/kerberos/include ./configure"

-----------------
Building from git
-----------------
The Radmind Development Team occasionally asks for help testing a new feature
or bug fix. The best way to assist is to download the source code from the
git repository and build it manually. The following steps will result in
a build from git.

1) Download the source from git:

    git clone git://radmind.git.sourceforge.net/gitroot/radmind/radmind

2) Move into the new radmind directory:

    cd radmind

3) Checkout all required submodules [1]:

    git submodule init
    git submodule update

4) Follow steps 2 and 3 from "More detailed instructions" for building, above.

------------
Known Issues
------------
On OpenDarwin based systems, the message "hfs_bwrite: called with lock bit set" is logged when you are doing a high volume of writes to a volume.

lcksum's progress output currently does not provide steady feedback increments.

----------------
More Information
----------------
If you have any problems with this source, you may want
to check http://radmind.org/ to see if any problems have
reports.  You can also contact the radmind development
team by e-mailing [email protected].

An archived e-mail discussion list has also been set up.  See the website
for details on how to join.

----------
References
----------
[1]: Current submodules:

    * libsnet, a networking library with TLS support
	http://sourceforge.net/projects/libsnet