View of /trunk/uia/README

$Id:$

Overview
--------

This is the top level directory for the various components
of the UIA project.  It consists of several loosely related
components.  Each is designed to be (possibly) used separately,
with a few build scripts to tie them together.

Components
----------

uianet -- system wide UIA installation
netsteria -- stand-alone chat application
sst -- Structured session transport
       (currently used by netsteria)
yam -- yet another mainloop
       (currently used by uianet)
vxa
vx32

Building and Installing
-----------------------

To check out from subversion:
  svn co svn://svn.pdos.csail.mit.edu/uia/trunk/uia

To configure to include all packages:
  ./configure

To configure to include only uianet (and yam):
  ./configure uianet --with-user=$USER [OPTIONS]
  
To configure only netsteria (and sst):
  ./configure netsteria [OPTIONS]

For configuration options, see the readme's in the
relevent component directories

Building:
  make

Installing:
  sudo make install   (though not all modules install anything)

License
-------

The UIA source code is distributed under the MIT open source license,
with the exception of the following components, which are distributed
under alternate licenses due to dependencies on existing code used
in those components:

1. The graphical control application in the 'uianet/ctl' subdirectory
   is distributed under the GNU General Public License (GPL), 
   because it relies on the GPL-licensed Qt toolkit from Trolltech.
   
2. The netsteria application in the 'netsteria' subdirectory
   is distributed under the GNU General Public License (GPL), 
   because it relies on the GPL-licensed Qt toolkit from Trolltech.

3. The SST protocol implementation in the 'sst' subdirectory
   is distributed under the GNU General Public License (GPL), 
   because it relies on the GPL-licensed Qt toolkit from Trolltech.

4. PLY (Python Lex-Yacc), included in uianet/naming/rpcgen/ply,
   is distributed under the GNU Lesser General Public License (LGPL).  
   PLY is used only for compiling uianet -- it is not needed to run
   UIA programs.