The information in this file is provided without warranty
for its accuracy or completeness. Use of this file or its
information is entirely at your own risk.

If you have read through this document thoroughly, and still fail
to build Cooledit for any reason, please do not hesitate to mail
the mailing list at:
    cooledit@mail.obsidian.co.za

(If you are upgrading from a previous version of Cooledit,
don't forget to delete your old man pages. The file
    ~/cedit/.cooledit.ini
is incompatable as of version 2.3.0 and should also be removed.
The file ~/.coolicon is incompatable as of version 3.7.0, where
Cooledit switched to a new drag and drop protocol. This may
be deleted from your home directory. Coolicon will still work,
although your scripts may fail.)


INSTALLATION PROCEDURE:
-----------------------

To compile and install Cooledit will take less than 8MB. About 
1MB will remain after you have deleted the source tree (ix86 though).
If you're superuser, feel lazy, and are sure that you have Python
and xpm installed properly, just un-tar the package and type
    ./0install-quick
or
    sh ./0install-quick
in the top source directory. Otherwise read on.


SUMMARY:
--------

(-2) Install the xpm package from ftp://ftp.x.org/contrib/libraries/
(-1) Install the Python distribution from http://www.python.org/
(O) un-tar package in /usr/src
(1) ./configure
(2) make
(3) make install
(4) add the command `coolicon -M <mail-file>' to one of the X startup scripts.
	This is done automatically to the /usr/lib/X11/xinit/xinitrc script. Check to
	see what was done.

((
You may type
    make uninstall
to uninstall Cooledit.
))

DETAILS:
--------

Coolicon requires libXpm.so (or libXpm.a) and xpm.h to be present on your
system. These come from the libXpm library:
    ftp://ftp.x.org/contrib/libraries/xpm-?.?.tar.gz
Without this Coolicon will not compile. Cooledit may however be installed
without Coolicon by doing: cd editor ; make ; make install

Cooledit requires Python to be installed. This is optional, but highly
recommended, since it allows Cooledit to be custom programmed with
beautiful Python scripts. Download Python from http://www.python.org/
If you are downloading a binary distribution, then the full developement
version (i.e containing the files libpython?.?.a and Python.h) is
needed.

You may compile Cooledit as a user, but you need to be root to
do a system install. You do, of course, have to have the X Window System
working on your machine.
    Copy the file cooledit-3.11.6.tar.gz to the directory you would
like to compile in, preferably '/usr/local/src' or '/usr/src', and
then change to that directory. (You can also compile in your home
directory.)


Then type,
    tar -xvzf cooledit-3.11.6.tar.gz
or
    gzip -cd cooledit-3.11.6.tar.gz | tar xvf -
(whichever works).

Then type,
    cd cooledit-3.11.6

((
   if you have a patch file you can now type
      gzip -cd patch_file_name | patch -p1
))

You can then configure the package by just typing,
    ./configure
However if you would like to set compiler optimisations, for a
smaller binary, type,
    CFLAGS=-O ./configure
or,
    setenv CFLAGS -O
    ./configure
whichever works on your shell. (Use -O2 instead of
-O if your compiler supports this. If you have gcc use
CFLAGS='-O2 -s -Wall -pipe -fomit-frame-pointer' ./configure)

Finally type
    make
to compile (which will take ages). Then type
    make install
to install, or (for a smaller binary),
    make install-strip


Finally, Coolicon must be envoked with your window manager. Coolicon
can co-exist with whatever window manager you are using. You might
put the command
    coolicon -M <mail-file> &
in you .xinitrc file in your home directory or in the system wide xinit
file (see the xinit man page and the coolicon man page for more details).

Done.

I have personally tested Cooledit on a few systems, and it has been
used by others on many systems. It will certainly work on ANSI
compatible systems. Please email me if it doesn't, as I'd like to
support all the Unix clones that I can.

You can remove the entire source after you have finished
reading the file COPYING, which contains the licensing
agreement. The FAQ though might be useful, as well as the file
INTERNATIONAL. Other files beginning with capital letters provide
further documentation and may be copied to a directory,
/usr/doc/cooledit. As of version 3.3.3, Cooledit is
dynamically linked. This means that Coolwidgets (libCw) is
installed as a proper shared library. You may not like this
arrangement and prefer the statically linked version. In this
case, overwrite the file cooledit with cooledit.static.

