====================
0: Table of contents
====================

1: Intro
2: Mailing list
3: Bugs
4: Requirements
5: Installation
6: Testing

========
1: Intro
========

Gtkhtml2 source tree is available from CVS (the latest-cutting edge
version).

If you plan to hack on Gtkhtml2, please make sure you work from the
CVS version. The CVS version is available on GNOME CVS. The page
http://developer.gnome.org/tools/cvs.html details how to get started
with GNOME CVS.

If you want to contribute patches, please send mail to the gtkhtml2 maintainers 
Jonas Borgström <jonas@codefactory.se> or Anders Carlsson <andersca@codefactory.se> 
and/or the gtkhtml mailing list.
Patches should be made with 'cvs diff -u > patch'.

===============
2: Mailing list
===============

More info on subscribing to the gtkhtml2 mailing list can be found at:
http://lists.codefactory.se/

===============
3: Bugs
===============

If you think you have found a bug you can write a bug report on
http://bugzilla.gnome.org/ But please make sure the same bug
hasn't already been reported by searching the bug database. 

If you want the bug to be fixed quickly, then it will help VERY much
if you write a small testcase. A testcase a minimal htmlpage that suffers
from the same bug as the original page. The easiest way of creating
a testcase is to start with the original page and then remove part after
part of the page until you have very small and overlookable page.

===============
4: Requirements
===============

Gtkhtml2 requires the CVS version of the following libraries (in this order):

 * pkg-config
 * glib
 * pango
 * atk
 * gtk+
 * gnome-xml
 * gnome-http
 * gail

Accessibility support is provided using gail. If you have good reasons 
to build without accessibility support, you can turn it off using the 
--disable-accessibility configure option.

===============
5: Installation
===============

The best location to install these libraries is in their own prefix. This 
can be done like this

  mkdir $HOME/bleeding
  export PATH=$HOME/bleeding/bin:$PATH
  export LD_LIBRARY_PATH=$HOME/bleeding/lib:$LD_LIBRARY_PATH

Then do the following for each of the required libraries:

  cd <librarysourcedir>
  ./autogen.sh --prefix=$HOME/bleeding --disable-static
  make install

If autogen.sh spills some errors about some undefined or unvalid macros
is can help to run 

  aclocal

before restarting from ./autogen.sh --prefix=$HOME/bleeding

==========
6: Testing
==========

After you have compiled gtkhtml2 like the other libraries you can test
if by running the "testgtkhtml" or the "simple" program from the 
"src/test/" directory.