# -*- text -*-
# README $Id: README,v 4.3 2008/10/27 15:34:11 hut66au Exp $
#

Introduction

     Imview is an image viewing package intended for image analysis, i.e:
      getting numbers (measurements) out of images. It is designed to
     interface easily to image analysis packages such as Khoros or Z-IMAGE
     (http://www.cmis.csiro.au/IAP/zimage.htm), to perform as an external
     viewer.

     It has facilities for histogram-based segmentation, comparing images
     before and after a series of filtering, etc. It supports many different
     image format and pixel types (integer and floating point, 1 to 64 bits).

     It can also perform more than adequately as a general-purpose image
     display application, but this is not the emphasis.

     Imview is free software distributed under the GNU public licence.

Version 1.1.x:

     Imview version 1.1.x is the currently unstable version based on FLTK 1.1.x

Roadmap

     IMVIEW consists of a main executable and a few support files. Among the
     support files there are:

              .lut files:  these are simple Colour Look-Up Table text 
                           files that associate a grey-level index to 
                           an RGB colour (false colours).             
              .html files: these are the online documentation (very   
                           slim at this stage)                        
              .jpg file:   this is the splash screen. Replace it or   
                           delete if you don't like it! Let me know   
                           if you make a better one.                  

     The main executable (imview) is a semi-static executable linked against
     a number of imaging libraries (JPEG, PNG, TIFF, ImageMagick) and the GUI
     toolkit (FLTK).

Installer:

     Imview is provided both in source and binary form. All binary formats
     come with an installer. If you downloaded the RPM then use the rpm
     installer to make use of it, otherwise Under Unix: untar the file and
     type ./setup Under Windows: simply execute the file.

     NOTE: 

     under windows 9x (95, 98 and me) you must make sure that TCP/IP is
     installed. If you have an internet connection you will be fine. TCP/IP
     is always present with Unix, NT, Win2k and WinXP.

Documentation:
				   
     Imview should be very simple to use, but full documentation is available
     in HTML, PS or PDF format, see the following web sites

     http://www.cmis.csiro.au/Hugues.Talbot/imview
     http://www.esiee.fr/~talboth/

     or

     http://imview.sourceforge.net/

To compile imview:

     See the INSTALL text file. Essentially you will need the FLTK library
     (http://www.fltk.org), and supporting imaging libraries if they are not
     present on your system.

     On Unix imview uses the POSIX thread library, TCP/IP sockets and the
     SYSV IPC if present. Under windows an implementation of POSIX threads is
     provided (SYSV IPC is not used, sockets are used instead).

The directory structure:

 imview.                     The main source repository
       |-- check             For regression testing (an interesting concept for GUIs)
       |-- client            Network client code (to remote-control imview)
       |-- distrib           To make distributions
       |   |-- binaries      Generic binary distributions
       |   |-- redhat        Specific to the RedHat RPM system
       |   |   |-- BUILD
       |   |   |-- CVS
       |   |   |-- RPMS
       |   |   |-- SOURCES
       |   |   |-- SPECS
       |   |   `-- SRPMS
       |   |
       |   `-- windows       Uses the Inno Setup installer for Windows
       |
       |-- doc               Documentation (online one only, full documentation is separate)
       |-- export            Used for making snapshots
       |-- fluid             Interface files (FLUID is the fast light user interface designer)
       |-- io                I/O library (all these different image formats)
       |-- obj               Compilation subdirectory
       |   `-- NT-msvc++     MSVC++ project files
       |       `-- fluid
       |-- server            Imview server (for remote control)
       |-- stl               Missing bits of the STL for egcs/gcc-2.95.x
       |   `-- sstream
       `-- support           Support files (LUT, etc).
