#
# $Id: README.txt,v 1.2 2005/08/08 04:16:07 wes Exp $
# Version: $Name: OpenRM-1-6-0 $
# $Revision: 1.2 $
#

7 August 2005

Contents:

1. Manifest
2. Unpacking
3. Running the demos
4. Warranties and Tech support (there is none)
5. Open Source Legal stuff

-------------

1. Manifest

This distribution contains pre-built binaries for Win32 platforms of
the following software components:
	- The jpeg-6b distribution;
	- The 10 May 2003 Distribution of Ross Johnson's pthreads for win32
	- OpenRM/rm160 development libraries and code
	- OpenRM/rmdemo (v1.6.0)- the OpenRM demonstration programs, 
	     src and exe's.
        - The FLTK 1.1.6 source distribution, along with a pre-built version
	     of FLTK 1.1.6.
	- The Gordo distribution (examples showing how to use OpenRM and FLTK)
	     source code and .exe's built for Win32.

These distributions were built using MSVC++ 6.0.

2. Unpacking

The simplest and easiest course of action is to unpack the distribution
into the root directory of your hard drive. It will create the following
directories:
	jpeg-6b\
		include\
		lib\
	pthreads\
		include\
		lib\
	openrm
		rm160\
		rmdemo\
	fltk\
		(bunch of FLTK subdirectories, including lib and FL)
	gordo\
		(several gordo subdirectories)

        originalSources
		

The reason this is the preferred course of action is so that the Makefiles
inside the openrm/rmdemo directory will map to directories inside the
jpeg-6b and pthreads - so you can modify and rebuild the demo programs
easily, if you so desire.

If your hard drive has multiple partitions (e.g., C:, E:, F:), unpacking
the distro into the root directory of any of those partitions will
work equally well.

The OpenRM/rm160 subdirectory contains prebuilt static libraries in 
the lib/ directory, and pre-built DLLs in the lib-dll directory. The
pre-built demo programs (the .exe's) located in rmdemo are linked with
static libs. To use the demo programs with DLLs instead, you'll need
to rename the lib-dll directory to lib (probably want to first rename
lib to lib-static, or something like that), then recompile the
demo programs. We chose to distribute the pre-built demos linked with
static libraries to minimize pain and suffering.

We built the rm160 libraries and DLLs using the "no-pthreads" build
target, which means that you don't need to do anything special
to your environment to have the demo programs (rmdemo, gordo) work OK.

3. Running the demos

Once you unpack everything, open a shell (Start->run, then type in
command (Win98, WinME) or cmd (Win2K, WinXP), depending upon your Win32 
environment). 

If you want to rebuild using a pthreads-enabled build target, you'll need
to set your path to point to the pthreads DLLs (note
you may have to modify these instructions if you've unpacked these files
into some location other than the root directory on your hard drive):

	C:> set path=\pthreads\lib;%PATH%

Then, you can cd into \openrm\rmdemo and run any of the .exe programs.

If you want to set your machine up so you don't have to modify your
$path variable manually, you can do so by adding \pthreads\lib to
the path used when shells are launched on your machine. On Win2K and
WinXP machines, you can do this by selecting
Start->Settings->Control Panel, clicking on "System", then 
"Advanced", then "Environment Variables." Find the line where the
Path variable is set, click on that line, then click Edit. You'll
be able to add a ";\pthreads\lib" to the end of the list of stuff
that's already there. 

Follow these instructions at your own risk - they work for me, but
I can't offer tech support for you.

4. Warranties and Tech support

There is no warranty on these Win32 OpenRM binaries:

THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

That said, R3vis will warrant that the code contains no viruses, trojans
or anything else that could be considered malicious, spyware, etc. The
code and the scripts included with the OpenRM v1.6.0 distribution do not
modify the registry on your system. R3vis warrants that all the .exe's 
included in the rmdemo directory worked on their test platforms (Win2K,
WinXP). R3vis also warrants that all .exe's for the RMdemo and Gordo
distribution are fully operational on our development and build platforms.

R3vis does not offer technical support for these demonstration programs.
Information about the demonstration programs themselves, including build
instructions, are available at the www.openrm.org site under the
category "Documentation Central."


6. Open Source Legal stuff

All of the components included with this distributution are freely
available, Open Source tools. You can obtain the source for the
components from the following locations:

OpenRM Scene Graph: openrm.sourceforge.net
JPEG library: www.ijg.org
Pthreads for Win32: sources.redhat.com/pthreads-win32
FLTK website: www.fltk.org

# EOF