# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# filename: README                                                        #
#                                                                         #
# UTILITY text: Medical Image Conversion Utility                          #
#                                                                         #
# purpose     : the (X)MedCon 'you-should-read' file                      #
#                                                                         #
# project     : (X)MedCon by Erik Nolf                                    #
#                                                                         #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# $Id: README,v 1.21 2005/05/15 22:28:12 enlf Exp $

Introduction:
------------
Here you can read first line information about the configuration, installation
and other issues related to (X)MedCon, a medical image conversion utility.

License & Copyright notices:
---------------------------
1. Read the files 'COPYING' & 'COPYING.LIB'

2. m-gif.c:  a)  changed original code GIF reader/writer copyright (c) 1991
                 Alchemy Mindworks, Inc.

             b)  Unisys Patent License ;-P

"No license or license fees are required for non-commercial, not-for-profit
 GIF-based applications or for non-commercial, not-for-profit GIF-freeware,
 so long as the LZW capability provided is only for GIF. However, a license 
 is required if freeware is incorporated into, or sold or distributed with a
 commercial or for-profit product, introduced in 1995 [or later], or
 enhancements of products that were introduced prior to 1995."

3. m-matrix.h: changed original code 'matrix.h'

       "2.6 10/19/93  Copyright 1989-1993 CTI PET Systems, Inc."

   m-matrix.c: changed original code 'matrix.c'

       "2.2 10/19/93  Copyright 1989-1993 CTI PET Systems, Inc."

   Most changes applied for host endian independence.

4. m-qmedian.c: code adapted from 'tiffmedian.c' (see http://www.libtiff.org)

   Copyright (c) 1988-1997 Sam Leffler
   Copyright (c) 1991-1997 Silicon Graphics, Inc.

  "Permission to use, copy, modify, distribute, and sell this software and
   its documentation for any purpose is hereby granted without fee,
   provided that (i) the above copyright notices and this permission notice
   appear in all copies of the software and related documentation, and
   (ii) the names of Sam Leffler and Silicon Graphics may not be used in
   any advertising or publicity relating to the software without the
   specific, prior written permission of Sam Leffler and Silicon Graphics." 

5. DICOM 3.0

 a) original library (libdicom 0.31 - 1998)
    ----------------

    Contributed by Tony Voet, released under the GNU (L)GPL license.
    Quite some changes have been made since.

 b) dictionary (dict-dicom.dic)
    ----------

    Dictionary borrowed from the superb OFFIS DCMTK Toolkit

    "Copyright (C) 1994-2001, OFFIS" (see http://www.offis.uni-oldenburg.de)

    For the full copyright & license notices see the "libs/dicom/README" file.

 c) encapsulated pixeldata (rle, lossless jpeg)
    ----------------------

    Contributed by Jaslet Bertrand, released under the GNU (L)GPL license.

    However, the lossless jpeg library (LJPG) is based in part on the work of:

    a) Cornell University LossLess JPEG lib   (see ftp://ftp.cs.cornell.edu)

        Copyright (c) 1993 Cornell University, Kongji Huang
        All rights reserved.

        Copyright (c) 1993 The Regents of the University of California,
        Brian C. Smith. All rights reserved.

    b) Independent JPEG Group's JPEG software (see http://www.ijg.org)

        This software is copyright (C) 1991, 1992, Thomas G. Lane.
        All Rights Reserved.

    For the full copyright & license notices see the "libs/ljpg/README" file.

What do you need:
----------------
machine OS: Unix/Linux  (MingW/Cygwin on MS Windows)
compiler  : gcc         (GNU C Compiler !!)
utilities : make        (GNU make       !!)

  - Gtk+ v1.2.8      or higher package from <http://www.gtk.org>
          Available? Type this to find out: 'gtk-config --version'
  - GdkPixbuf v0.8.0 or higher package from <http://www.gnome.org>
          Available? Type this to find out: 'gdk-pixbuf-config --version'

What to do first:
----------------
When you need GUI support:

    - install Glib/Gtk+ package: (make sure the shared libs are found)
    - install GdkPixbuf package: (make sure the shared libs are found)

         (GdkPixbuf doesn't install easily on every platform)
         (Perhaps we can help to get it working:  'make -i' )

Configuring the (X)MedCon project:
---------------------------------
type: './configure' or 'sh ./configure'

The default installation directory is "/usr/local/xmedcon". You can use
the option "--prefix" to override this default directory.

All supported formats are enabled. If you need to, you can disable one by
adding an option like "--disable-format". For more information about the
autoconf configure script, just type 'configure --help'.
  
Make the (X)MedCon project:
--------------------------
type: 'make'

Install the (X)MedCon project:
-----------------------------
type: 'make install'

You must install the project, since the files in the source directory are
merely wrapper scripts. If you use the default prefix installation dir, make
sure to become "root" before the actual installation. For the executables to
be found you could make links to them from a bin-directory included in your
"PATH" or add the distribution bin-directory to this environment variable.
Try to run the newly installed executables. When they can not find a library,
make links or add the distribution lib-directory to your "LD_LIBRARY_PATH"
environment variable or something appropriate for your O.S.

Uninstall the (X)MedCon project:
-------------------------------
type: 'make uninstall'

Libraries & package structure:
-----------------------------
The relation between it all, is as follows:

 Extra             (X)MedCon              (X)MedCon
Packages            library               programs
--------            -------               --------
VT-DICOM - - +         + - - - - - - - -> medcon     (command-line)
(static)     |         |
             |         |
             |         |
             + - ->  libmdc
             |   (static/shared)
  LJPG   - - +         | 
(static)               |
                       |
                       |
Gtk+   - - - - - - - - + - - - - - - - -> xmedcon     (graphical)
GdkPixbuf
(shared)


Contacts:
--------
Any problems? 	e-mail: enlf-at-users.sourceforge.net
Where to get?   URL   : http://xmedcon.sourceforge.net

