Installing Clean
================

First compile the executable files using:

cd src
make
cd ..

By default the Clean system is installed in the current directory.
You can override these defaults by changing INSTALL_BIN_DIR,
INSTALL_LIB_DIR, INSTALL_MAN_DIR in the Makefile.

Clean can be used using the CleanIDE, an IDE using X windows, or
from a shell using a command line interface (clm).

The CleanIDE should be used by only one person at a time. If you want to
use this IDE, install Clean in your own directory. clm can be used by more
than one person at a time, and so its installed files can be shared.

To install the Clean system *without* the Clean IO interface type:

	% make

To use the Clean IO interface, you need X-windows with the
Xview ToolKit.

To install the Clean system *with* the Clean IO interface,
first check the variable OPENWINHOME. It should point to the
directory where OpenLook is installed on your system. Then type:

	% make io

* Warning *
There are several problems with the X windows implementation
of the Clean IO library. We regret that we currently cannot
support it.

Using Clean
===========

To compile Clean programs from a shell you use the command 'clm'. The manual
page for clm provides more information.

To compile Clean programs using the CleanIDE, start the CleanIDE, open the
main module (a .icl file that begins with "module"), create a new project,
and then select "Bring up to date" from the Command menu.

For the IO demos you should use the '-sl' flag to specify a
link options file.

	'-sl x'	# Xview toolkit

Compiling the example programs
==============================

The directory 'examples' contains small Clean programs. The
directory 'iodemos' contains a number of IO programs. Both
directories contain a Makefile to compile the demos.

General Info
============

More information about Clean is available on the World Wide Web:

	http://clean.cs.ru.nl

Bug reports, questions and suggestions are welcome. Please send
them to:

	mailto:clean@cs.ru.nl
	
The Clean Software is also available via ftp:

	ftp://ftp.cs.ru.nl/pub/Clean

Versions of Clean are available for several platforms. 

