
                      Geomview/OOGL Release 1.1

                                  by
            Stuart Levy, Tamara Munzner, and Mark Phillips

                         The Geometry Center

 			    June 12, 1992
			    ------------

INTRODUCTION
------------
                                   
This is version 1.1 of Geomview/OOGL. It runs on Silicon Graphics IRIS
workstations.

Geomview is an interactive 3D object viewing program.  OOGL, which
stands for Object Oriented Graphics Library, is the library upon which
Geomview is built.

Geomview is copyrighted software.  Please read the file COPYING in
this directory before using or distributing Geomview.
    
Geomview represents the current state of an ongoing effort at the
Geometry Center to provide interactive 3D graphics software which is
particularly appropriate for displaying the kinds of objects and doing
the kinds of operations of interest in mathematics research and
education.

[ Note to users of MinneView (the precursor to geomview): Geomview can ]
[ read MinneView data files, but it is much more general and powerful  ]
[ than MinneView.  (MinneView cannot read all geomview files.)  See    ]
[ the file "overview" in the "doc" subdirectory for a more detailed    ]
[ comparison to MinneView.                                             ]

INSTALLATION
------------

Throughout these instructions, the name GEOMROOT stands for the root
directory of the Geomview source tree (the directory containing, among
other things, this file and a file called "config".)

NOTE: The installation procedure depends on whether you have the
source distribution or the binary distribution.  If the directory
"src" exists in the GEOMROOT directory, you have the source
distribution.  Otherwise you have the binary distribution.  The
binary version is provided for the benefit of users who do not have
a C compiler or who do not want to bother with the source code.
The source distribution available free of charge via anonymous ftp
from geom.umn.edu.

INSTALLATION (BINARY DISTRIBUTION)
------------ ---------------------

To install the binary distribution you will need approximately
3 MB of disk space.

1. cd to the GEOMROOT directory.

2. Type "installbin". (It is important that the current directory be
   GEOMROOT when you do this.)  This creates a shell script called
   "geomview" which will run geomview.  You may move this shell script
   to another directory (one on your search path, for example) if you
   want.

[ You only have to do steps 1 and 2 once, to create the "geomview" ]
[ shell script.  Once this is done, you can just type "geomview"   ]
[ to invoke the program.                                           ]

3. Now proceed to the section "RUNNING GEOMVIEW" below for
   instructions on how to run it.

INSTALLATION (SOURCE DISTRIBUTION)
------------ ---------------------

To build and install the source distribution you will temporarily need
approximately 21 MB of disk space.  The final binary, example files,
and documentation take up under 3 MB.

1. cd to the GEOMROOT directory.

2. If you are using the Bourne shell or some other non-C-like shell,
   start up the C-shell by typing "csh".

3. Type "source config".  (It is important that the current directory
   be GEOMROOT when you do this.)  This sets some environment settings
   which are necessary for compiling Geomview.

4. If you plan to install Geomview in some directory outside of its
   source tree, edit the file Makedefs in the GEOMROOT directory.  That
   file contains comments telling you what to do.  If you plan to
   leave Geomview installed in its source directory, you may skip
   this step.

5. Type "make depend", to build Make-dependencies files throughout the
   source tree.  This is only essential if you'll be making changes (or
   applying patches) to the code, but is a good idea and shouldn't take long.
	
6. Type "make"; this will compile Geomview and its associated libraries.
   This step will take a while --- anywhere from 15 minutes to an hour,
   depending on what kind of machine you have and on how busy it is.
   [ If you have a multiple-processor IRIS you can type "pmake" instead;
   this will speed things up considerably. ]
   [ If you are compiling under Irix 4.0.1, and the Geomview sources
    are on an NFS-mounted filesystem (rather than a local disk on that Iris),
    a C compiler bug makes compilation very slow -- ~ 1 hour on our systems.
    You can avoid this by compiling without the -g option.  An easy way to
    do that is to type  "setenv MORECOPTS -g0" or "setenv MORECOPTS -g1"
    before running "make".  Using -g0 turns off all debugging support,
    and makes object files much smaller; -g1 allows partial debugging.
    The compiler bug is due to be fixed in Irix 4.0.6.]

   During the compilation, you may see various "warning" messages,
   which you may ignore.  There should be no "error" messages, though.
   If you do get error messages, please report them via email to
   software@geom.umn.edu.

7. Type "make install"; this will install the compiled Geomview.  The
   final executable file is bin/sgi/geomview (or bin/sgi/gv, which is
   just a link to bin/sgi/geomview) under the GEOMROOT directory.  The
   "config" file which you executed in step 3 above arranged for this
   directory to be on your search path.  If you later run Geomview
   from a different shell, you may have to type the full pathname
   GEOMROOT/bin/sgi/geomview, or arrange for GEOMROOT/bin/sgi to be on
   your search path.

8. If you want to install Geomview outside of the source tree, simply
   move all the executable files in GEOMROOT/bin/sgi to the desired
   location at this point; there are several --- geomview itself, and
   a few sample programs that work with it.

RUNNING GEOMVIEW
------- --------

For a quick demo, type "geomview dodec.off".

You should see two windows appear on the screen; a large one with a
dodecahedron in it, and a smaller one with some control buttons and
other things.  To rotate the dodecahedron, put the mouse cursor over
it, hold down the left mouse button, and move the mouse.

See the files "oogltour" and "overview" in the doc subdirectory of
GEOMROOT for a more extensive tutorial which explains some other
things about Geomview and serves as an introduction to the OOGL data
file format.  For still more details, see the man pages geomview.1,
geomview.5 and oogl.5, also in the doc subdirectory.

Currently the documentation is scanty; there are a lot of undocumented
features.  We will be adding to the documentation in future releases.

HISTORY
-------

This project began in the sumer of 1988 with the work of Pat Hanrahan
on a viewing program called MinneView.  Shortly thereafter Charlie
Gunn begin developing OOGL in conjunction with MinneView.  In the time
since then, many people have contributed, including Mark Meuer, Steve
Anderson, Mario Lopez, Todd Kaplan.  The current version was written
by Stuart Levy, Tamara Munzner, and Mark Phillips.

REPORTING PROBLEMS
--------- --------

We are very interested in hearing about your experience using it,
especially if you have problems.  Send all comments and reports via
email to

                        software@geom.umn.edu

or via regular mail to

                         Software Department
                           Geometry Center
                       1300 South Second Street
                        Minneapolis, MN  55454
                                 USA
