gtk3/docs/reference
Colin Walters 22527e802c Clarify documentation header about GTK+ 3 vs 2
I think it's confusing for a lot the developers out there who
may not even be aware of GTK+ 3 coming, if suddenly GTK+ 3 becomes
the "stable" version of "gtk" on library.gnome.org.  It may
not even be feasible for them to port to GTK+3 if it's not
shipped in the operating systems they're targeting (for example,
RHEL 6).

Since practically speaking, we expect people to consume GTK+ 2 for
several years at least, redirect these people to the right pages.

(I didn't attempt to explain the differences between the libraries
 here, but hopefully the major version difference is enough of a hint)

As a side effect, this makes the generated HTML look better; previously
it looked rather crappy, since the "for GTK &version;" was totally
offset and in a different group from the documentation title.
2011-01-27 11:32:55 -05:00
..
gdk Silence automake warnings 2011-01-03 11:59:45 -05:00
gtk Clarify documentation header about GTK+ 3 vs 2 2011-01-27 11:32:55 -05:00
libgail-util Fix libgail-util doc build 2011-01-05 10:12:16 -05:00
AUTHORS Initial revision 1999-08-16 18:51:52 +00:00
ChangeLog Removed empty docs/reference/ChangeLog entries. I am using prepare-ChangeLog.pl to help create informative commit messages and this was a side-effect. 2009-07-16 18:13:34 +02:00
COPYING Initial revision 1999-08-16 18:51:52 +00:00
Makefile.am Make GTK+ use an external gdk-pixbuf 2010-06-26 01:09:05 -04:00
README Initial revision 1999-08-16 18:51:52 +00:00
README.cvs-commits Initial revision 1999-08-16 18:51:52 +00:00

This package contains the reference documentation
for GTK+. For more information about GTK+
see:

 http://www.gtk.org

For information about contributing to the
GLib/GTK+ reference documentation project, see:

 http://www.gtk.org/rdp/

The GTK+ reference documentation is freely redistributable,
see the file COPYING for details.


REQUIREMENTS
============

To build the documentation, you must have the gtk-doc
package installed. To rebuild the template files,
you must have the current version of the GTK+
header files installed.


BUILD
=====

First, run configure to generate the makefiles for this
module. There is one option specific to this package

  --with-html-dir=DIR   top of installed HTML documentation tree


The Makefiles in the gdk/ and gtk/ subdirs each define three targets:

 templates:
  
  Scan the headers and merge the results with the current 
  template files

 sgml:

  Generate SGML files using the DocBook DTD from
  the template files

 html:

  Generate HTML from the SGML files.

To build the documentation, do:

 make sgml
 make html

You should only run the 'make templates' step if you
need to regenerate the templates for a more recent
version of the GTK+ sources.

INSTALLATION
============

 make install