# #######################################################################
#
#  XXL README - Version XXL98.6
#  E. Lecolinet
#
#  Part of the XXL System: A Visual+Textual Environment for Building GUIs.
#
#  (C) 1996/98 Eric Lecolinet, ENST, 46 rue Barrault, 75013 Paris, France
#  WWW: http://www.enst.fr/~elc/XXL     Email: elc@enst.fr (Subject: XXL)
#
# #######################################################################


XXL is Visual+Textual environment for building GUIs on the top of the
X Window system and the Motif Toolkit

XXL is free software; you can redistribute it and/or modify it under 
the terms of the GNU General Public License as published by
the Free Software Foundation.
Please refer to files COPYRIGHT and COPYING.

The INSTALL file describes how to install this package.
It requires Unix (Sun Solaris if prefered), X-Window and Motif or CDE.
You will also need an ANSI C compiler (gcc is prefered).
Program 'xlsketch' also requires a C++ compiler.

Documentation is available at URL:  http://www.enst.fr/~elc/XXL
The XXL Builder also includes on-line documentation.


# #######################################################################
# XXL VISUAL AND SKETCH BUILDER #

After installation, binaries should be in directory: something/XXL/bin
and libraries in: something/XXL/lib

Program 'xlbuild' starts the XXL Visual Builder. Note that running this 
program requires backing store capabilities from the X Server and a reasonable
number of available "free colors". 

Program 'xlsketch' starts the XXL Visual Builder AND the Sketch Builder.
The Sketch Builder makes it possible to build GUIs from rough sketches.
It is fully compatible with the Visual Builder.

These 2 programs can either produce XXL Scripts or C Programs. 

XXL Scripts can be executed:
  * by loading them from 'xlbuild'
  * by invoking 'xlsh', the XXL Shell, by typing:   xlsh  script_name    
  * directly by typing their name 
    (in which case they must be made executable and their first line must 
    refers to the actual location of the 'xlsh' program in the file system)

C (or C++) programs can be compiled by using an ANSI C or a C++ compiler.
They must be linked with the X, Motif and XXL libraries (see below).
A Makefile is produced by the XXL Builder when generating a new C Program.


# #######################################################################
# VISUAL EDITION AND TEXTUAL EQUIVALENCE #

XXL Scripts and C Programs can be changed interactively by using the
XXL Builder while they are being executed. Their code will be modified
"on the spot" and in an incremental way.

To start a C Program AND the XXL Builder, type:   your_program  -build
(ie. start your program with option: -build)

Note that the source files that contain XXL GUI descriptions must be 
in this same directory. The executable must also be "up to date" (it must
has been recompiled since last modification).

Direct textual edition of C/C++ source files (by using emacs, vi or whatever)
is allowed. Visual edition by using the XXL Builder will remain possible
as long as you don't break the XXL syntax. So, direct textual edition
and interactive visual edition can be mixed at will at different stages.

XXL Script files can be changed interactively by loading them from
the XXL Builder. 

Note that XXL Scripts can be transformed into C Programs by the XXL Builder
but that the opposite is not true (although you can still do it manually).

XXL Scripts are generally used for making early prototypes which are
eventually transformed into C programs. However, note that XXL Scripts can
also be dynamically called from C programs (and share data with them) 
or be exchanged between several C programs through a socket connection.


# #######################################################################
# LIBRARIES #

There are two XXL libraries (in directory: something/XXL/lib) :

 - libXl.a must be linked with all XXL programs.
   It acts as a software layer on the top of the X/Motif Toolkit.

 - libXlb.a is only necessary at developpment time. 
   It makes it possible to change program interactively by using
   the XXL Builder.

Both libraries are always linked with C Programs by default.

Remove libXlb.a and compile ALL C files with label:  -DNO_BUILDER
if you want to prevent further visual edition of the corresponding program
(furthermore this will also reduce the size of the executable file).


# #######################################################################
# EXAMPLES #

* in directory bin:
  - xlpad    : an example that displays Sun rasterfiles and gif89 images
  to start it in builder mode type:   xlpad -build  like for any other program

  - xlget, xlsend : two programs that can exchange XXL Scripts through
  a socket connection.

* in directory 'examples':
  - various C examples

* in directory 'scripts'
  - various XXL script examples


# #######################################################################
# MANUALS #

* Web documentation at URL:  http://www.enst.fr/~elc/XXL

* On-Line documentation of the XXL Builder in directory:  html/AutoHelp

* On-Line documentation of the Motif Widgets in directory:  iman
  Note that the 'iman' files are compiled versions of the standard Motif
  'man' files. These files will be created when installing XXL if and 
  only if the Motif man pages are already properly installed on your system
  (eg. if command:  man XmPushButton .... works properly)