	       The Hacker's Guide To VCDImager (THGTV)
	       =======================================
				   
    this document is meant for the brave ones, who dare trying to
  understand the source code in this package or want to	contribute...


Savannah Project Page
~~~~~~~~~~~~~~~~~~~~~

http://savannah.gnu.org/projects/vcdimager/

CVS
~~~

First of all, you should familiarize yourself with the cvs repository
of this package, since the bugs you want to fix, may have already have
been fixed there...

Anonymous WebCVS Access
~~~~~~~~~~~~~~~~~~~~~~~

You can take a look the cvs repository anonymously through:

http://subversions.gnu.org/cgi-bin/cvsweb3/vcdimager/

If you want to do serious work, try some of the below mentioned CVS
access methods.

Anonymous pserver CVS Access
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This project's CVS repository can be checked out through anonymous
(pserver) CVS with the following instruction set.
When prompted for a password for anoncvs, simply press the Enter key.

Source tree:
$ cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/vcdimager login
 
$ cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/vcdimager co vcdimager

Developer CVS/SSH Access
~~~~~~~~~~~~~~~~~~~~~~~~

Write access is only useful, if you plan to become a permanent
contributor, if you only want to submit a few bugfixes diffs are more
adequate. Please contact me, if you want to become a developer for
this project.

CVS Branches
~~~~~~~~~~~~

starting from 0.6.z development has been separated into 'stable' and
'unstable' branches.

Even minor release numbers (x.Y.z, where Y mod 2 == 0) are supposed to
be the stable branches, e.g 0.6.z, 0.8.z, 1.0.z, ...  The (stable)
branch tags are named rel_x_y_branch, with x and y being the major and
minor release numbers respectively.

The latest development/unstable branch is always kept in the 'HEAD'
branch.

Source Organization
~~~~~~~~~~~~~~~~~~~

This package is more or less separated into a backend library, where
the core work is done, and frontends, which interface to this library.

The backend library is not ready to be distributed separately
_yet_. (API is to be redesigned, memleaks are still featured, error
handling is incomplete, ...) 

Required Tools
~~~~~~~~~~~~~~

When working directly from CVS the following additional requirements
exists for building vcdimager 0.7.x:

* GNU Automake 1.6.3 or later
* GNU Autoconf 2.53 or later
* GNU help2man 1.25 or later
* GNU libtool 1.5 or later
* cvs2cl (http://www.red-bean.com/cvs2cl/)

hvr@gnu.org
--
$Id$
