   ===================================================================
               Ubit: the Ubiquitous Brick Interactive Toolkit
              a Brick Construction Game Model for Creating GUIs
                Copyright (C) E. Lecolinet - ENST/INFRES 2000
    Email: elc@enst.fr (Subject: Ubit)     WWW: http://www.enst.fr/~elc
    ===================================================================


*** REQUIREMENTS ***********************************************************

  - Unix/Linux with X-Window (X11R5 or X11R6)

  - the Xpm library (for dealing with X Window pixmaps)
    This library is free software and is installed with the X lib
    (or Openlook or Motif or CDE) on most systems.

    Anyway, the Xpm distribution is included in the Ubit distribution
    so that you can install it if needed


*** FILES ******************************************************************

  - ubitX-Y-Z.tar.gz :  contains Ubit C++ source and pixmap files
                        [ X is the year
                        [ Y the month
                        [ Z is the release number during this month

    available from: www.enst.fr/~elc/ubit


*** COMPILATION AND INSTALLATION ******************************************

  - get the current archive file:    ubitX-Y-Z.tar.gz
  - uncompress this file:            gunzip ubitX-Y-Z.tar.gz
  - untar the resulting file:        tar xvf ubitX-Y-Z.tar

  This will create a "ubitX-Y-Z" directory
  - change directory:                cd ubitX-Y-Z

  Then execute the following GNU commands:
                                     ./configure
                                     gmake
  NOTE:
    configure --help 
    will give you important info about possible configuration options

  IF YOU DON'T HAVE configure installed on your system
  - edit and customize the "ConfMake" file (see below)
  - then run:      make -f makefile-sun


*** TESTING *********************************************************

   - the (static) library name is:       libubit.a

   - demo programs are in directory:     demos

   - note that some demo programs load
      pixmap files located in directory: images

  NOTES:
    configure will also create dynamic libraries
    but, unfortunately, dyn libs don't work on Solaris

    the system has been tested on Linux, FreeBSD and Solaris

    of course there are still bugs and still a few things to change
    in the API

    Ubit was used for making the GUI of *VREng* (Virtual Reality Engine)
    freely available at url:  www.enst.fr/~dax


*** NOTES if you don't have configure *******************************

 The 'ConfMake' file must set several Makefile macros in an appropriate way:

  - XDIR : the X-Window directory
    for instance (depending on your own installation) :

          XDIR=/usr/openwin
      or  XDIR=/usr/X11
      or  XDIR=/usr/local/X11
      or  XDIR=/usr/local/X11R5
      or  XDIR=/usr/local/X11R6
      etc ....

    (Note: Ubit will either work if using X11R5 or X11R6)

   - XPMFLAGS : should be commented (that's the default) if the Xpm library
     is available. Uncomment this macro if not.

   - SYSTEM_LIBRARIES : depend on your operating system
     (the current setting should be ok for Sun/Solaris, HP*UX ...)

   - CCC : C++ compiler
     g++ (the default) or Sun CC should work fine

     !!!NOTE : recent versions fg g++ (2.95 and more) may require the -fpermissive
     !!!option for compiling certain versions of the X11 include files


