=========================================================================
CONTENTS  --  CONTENTS  --  CONTENTS  --  CONTENTS  --  CONTENTS
=========================================================================

   Requirements
   Downloading
   Documentation
   Known Problems
   Bugs Reports
   Future Plans

=========================================================================
REQUIREMENTS  --  REQUIREMENTS  --  REQUIREMENTS  --  REQUIREMENTS
=========================================================================

  - Stuff required for TargetJr other than Fresco.

  - OpenGL [or Mesa]
    You will need to configure for OpenGL, with something like
       --with-opengl=/path/to/OpenGL
    and, if the libraries are in a funny place, also :
       --with-opengllibs=/path/to/OpenGL/libraries

  - A GUI toolkit.

  Currently supported GUI toolkits:
  ---------------------------------

  - GTK (GIMP Toolkit).  For this you will need:
       GTK (gtk+-1.2.5 or later) from http://www.gtk.org/
       GtkGLarea (gtkglarea-1.2.1 or later)
       glib

    When you run configure in TargetJr you will need to add these
    config flags:
       --with-gtk-prefix=/path/to/gtkinstallation
       --with-gtkglarea=/path/to/gtkglareainstallation
       --with-gtkglarealibs=/path/to/gtkglareaincludes

  - FLTK  (Fast Light Toolkit)
       FLTK (fltk-1.0.2 or later) available from http://fltk.easysw.com/

    You will need to add these config flags:
      --with-fltk=/path/to/fltk

  - Motif

    You will need to add these config flags:
      --with-motif=/path/to/motif
      --with-motifgl=/path/to/motifgl

  - glut (OpenGL utility toolkit)

    You will need to add these config flags :
      --with-glut=/path/to/glut
    and, if they're not near the headers, possibly :
      --with-glutlibs=/path/to/glut/libraries
    and, if the library is called something funny like libfsm-glut.so, possibly :
      --with-glutname=fsm-glut

=========================================================================
DOWNLOADING  --  DOWNLOADING  --  DOWNLOADING  --  DOWNLOADING
=========================================================================

  - vgui can be downloaded, as part of vxl, from
    ftp://ftp.esat.kuleuven.be/pub/psi/visics/TargetJr/vxl-*.tgz

  - Here are some URLs you might find useful in connection with it :

    http://www.opengl.org
         The starting point for any question about OpenGL.

    http://trant.sgi.com/opengl/docs/man_pages/hardcopy/GL/html/
         The OpenGL man pages in HTML. Appears to have been generated
         directly from the SGI insight books.

    http://www.mesa3d.org/
         Presumably the Mesa home page, unless there's some legal reason
         why I'm not allowed to call it that.....

    http://www.opengl.org/Documentation/GLUT.html
         Information about GLUT, including the API documentation.

    http://www.fltk.org/
         The FLTK home page.

    http://www.gtk.org/
         The GIMP Toolkit home page.

    http://www.student.oulu.fi/~jlof/gtkglarea/
         You can get GtkGlArea here.

    http://www.devolution.com/~slouken/SDL/
         For the "Simple DirectMedia Layer" page.

=========================================================================
DOCUMENTATION  --  DOCUMENTATION  --  DOCUMENTATION  --  DOCUMENTATION
=========================================================================

Documentation will be available in the $IUEROOT/vxl/vgui/doc directory.
This includes:

  - Reference manual
    This is aimed at developers.

  - vgui User's Guide
    A tutorial guide giving a series of examples on  how to use vgui.

  - HTML documentation on the class interfaces.
    To generate this type :
    make htmlpages
    in the top vgui directory. The index will be called HTML/classes.html

=========================================================================
KNOWN PROBLEMS  --  KNOWN PROBLEMS  --  KNOWN PROBLEMS
=========================================================================

=========================================================================
BUG REPORTS  --  BUG REPORTS  --  BUG REPORTS  --  BUG REPORTS
=========================================================================

  - Please send all bug reports to vxl@robots.ox.ac.uk, placing only
    the words "vgui bug report" in the title field. While we cannot
    guarantee a response, you may well get one; we do want to know about
    bugs so that we can fix them or better document things that may look
    like bugs but aren't.
    It would be helpful to know which platform (eg. solaris, WinNT, SGI)
    you are using, the toolkits you use with vgui, the vgui release
    version and whether or not you use Mesa.

=========================================================================
FUTURE PLANS
=========================================================================

  - Support for other GUI toolkits, in particular Qt, Microsoft
    Foundation Classes (MFC) and SDL.
