--------------------------------------------------------------
Twin - a Textmode WINdow environment, by Massimiliano Ghilardi
--------------------------------------------------------------

Version 0.4.0

Twin is a windowing environment with mouse support, window manager,
terminal emulator and networked clients, all inside a text display.

It supports a variety of displays:
* plain text terminals (any termcap/ncurses compatible terminal,
  Linux console, twin's own terminal emulator);
* X11, where it can be used as a multi-window xterm;
* itself (you can display a twin on another twin);
* twdisplay, a general network-transparent display client, used
  to attach/detach more displays on-the-fly.

Currently, twin is tested on Linux (i386, PowerPC, Alpha, Sparc)
and on FreeBSD; SunOS porting is in progress.
I had yet no chance to seriously test it on other systems.
   
--------------------------------------------------------------
Documentation


Twin comes with the following documentation:

README		This file.
README.CVS	Hints to build twin from CVS repository (for developers).
README.porting  Tips and warnings to compile twin on unsupported OSes.
COPYING		License. Twin is GPL'ed software.
COPYING.LIB	License for libTw. The library to talk to twin is LGPL'ed.
Changelog.txt	List of all changes between the various versions of twin.
BUGS		Known bugs of twin.
INSTALL		Reference to installation guide, located in docs/Tutorial.
system.twinrc	A detailed example of ~/.twinrc look-n-feel configuration file.


The docs/ subdirectory contains additional documentation:

Configure	Description of twin configuration script with the meaning
		of every single option.
Tutorial	A quite complete tour of twin features: the user interface,
		how to use twin clients, compression, attaching/detaching
		displays, fonts. It also contains installation instructions
		and some caveats for system administrators.
libTw.txt	a reference file for programmers who want to write
		twin clients (INCOMPLETE).
libTw++.txt	a reference file for programmers who want to write
		twin C++ clients (INCOMPLETE).

--------------------------------------------------------------
Getting twin


Since you are reading this README, you probably already have it,
anyway twin can be downloaded from

http://sourceforge.net/projects/twin/


--------------------------------------------------------------
Building and installing twin

For the impatient, it basically reduces to
./configure
make
make install

But of course you may want to know more details:
First, you might want to edit the files `makerules' and `makeautoconf.in'
to change the install directory, tweak compiler flags (enable debugging), etc.
Also, someone may want to tweak the configuration options generated
by `./configure'; this is possible with `make config' or `make menuconfig'
-- warning: if you enable options that were disabled by `./configure',
build will almost certainly fail! --
but `make config' or `make menuconfig' ask questions for many options
one may not know the meaning of.

For a discussion about MANUALLY configuring twin (almost never necessary),
see the file `Configure', distributed with twin in the docs/ subdirectory.
For instructions about installing twin, see the file `Tutorial',
section 4, again in the docs/ subdirectory.

--------------------------------------------------------------
Other topics:

See the rest of the documentation.


Greetings,

Massimiliano Ghilardi

