=================================
VDK 1.2.0 INSTALLING INSTRUCTIONS
=================================
please report any comment or bug to:
mmotta@users.sourceforge.net

=====================
PREPARING THE PACKAGE
=====================
If you haven't yet untarred the file, do

$ tar xvzf vdk-1.2.0.tar.gz

$ cd vdk-1.2.0/

=======================
CONFIGURING THE PACKAGE
=======================

$ ./configure

Configure will accept several options 
(to see all of them do ./configure --help)

Here the most used:

    --prefix=[DIR] where to install it [default=/usr/local]
	For RedHat and  Redhat-like distributions i suggest to
	use --prefix=/usr to make things simpler.
 
    --enable-debug=[no/minimum/yes] it enable the debug system [default=no]
	    no = it will compile with -s flag
	    minimum = with -s -DVDKDEBUG (defined in config.h)
	    yes = with -g -DVDKDEBUG

    --enable-shared/static=[yes/no]
	build shared/static library [default=yes]

    --enable-opt=[OPTIMIZATION/no]
	build with -O$(OPTIMIZATION) compiler lever [default=2]
	it can be disabled with no

    --enable-testvdk=[yes/no]
        build or not testvdk program [default=yes]

    --enable-sigc=[yes/no]
	build or not vdk signal system extension [default=no]
	This options requires libsigc++-0.8.5 or greater
	already installed.
	You can download above library at:
	http://libsigc.sourceforge.net/stable.html

    --enable-testsigc=[yes/no]
	build or vdk signal system extension test program [default=no]	
	This options requires libsigc++-0.8.5 or greater
	installed.
	You can download above library at:
	http://libsigc.sourceforge.net/stable.html

    --enable-gnome=[yes/no]
	build or not vdk gnome support library [default=no].
	You need Gnome libs installed in order to have gnome
	support. Running gnome is not required however.

    --enable-doc-html=[yes/no] (default=yes)
    --enable-doc-latex=[yes/no] (default=no)
    --enable-doc-man=[yes/no] (default=no)	
	Enables doc building in html, latex or man format.
	You need doxigen tool and Qt installed in order to
	build docs.
	You can download doxygen at:
	http://www.stack.nl/~dimitri/doxygen/index.html

==================
MAKING THE PACKAGE
==================
When configure finish do

$ make

This will produce:
- 	core library libvdk.so.1.2.0 and links
- 	component library libvdkcompo.so.1.2.0 and links
- 	a configure script vdk-config to use when compiling your
	vdk programs,to be used as gtk-config.

option depending:
- 	gnome support library libvdkgnome.so.1.2.0 and links
- 	test program in ./testvdk/testvdk
- 	extended signal system test program in ./sigcvdktest/testsigcvdk
-	classes references in ./doc/doxy/html/index.html

======================
INSTALLING THE PACKAGE
======================
To install just do
# make install
(you may need root privilege)

This will install:
-	core and component libraries in $(prefix)/lib
-	include headers in $(prefix)/include
-	configure script vdk-config in $(prefix)/bin

======================
BUILDING DOCUMENTATION
======================
Do:
$ make docs
This will produce a ./vdk-1.2.0/doc/doxy/html dir
plenty of html and gif files.
Just run:
$ netscape ./vdk-1.2.0/doc/doxy/html/index.html&
or open ./vdk-1.2.0/doc/doxy/html/index.html
in your preferred browser to read VDK class reference.
To make a postscript printable version you need to
./configure with ..enable-doc-latex=yes and
$ cd ./vdk-1.2.0/doc/doxy/latex
$ make ps
this will produce a refman.ps
If you do not want build docs by yourself (almost
html format is recommended) you can download from
vdkbuilder website vdk120.ps.gz in ps format and print it.
A M$ Word97 format is also available in vdk120.zip


**************************************************
* Note for Red Hat users (and most likely others)*
**************************************************
If you have used the default prefix for installation
- check if /etc/ld.so.conf contains this line:
/usr/local/lib
(if not add it to the file)

- check if your PATH points to /usr/local/bin

Run: # /sbin/ldconfig

after have modified /etc/ld.so.conf


=========
CLEANING
=========

$ make clean
This will remove all obj's and libs from source tree

$ make distclean
This will remove all file created by configure
(You will need autoconf/automake to rebuild all the package)

Enjoy.
VDKTeam




