Blame docs/reference/README

Packit 98cdb6
This package contains the reference documentation
Packit 98cdb6
for GTK+. For more information about GTK+
Packit 98cdb6
see:
Packit 98cdb6
Packit 98cdb6
 http://www.gtk.org
Packit 98cdb6
Packit 98cdb6
For information about contributing to the
Packit 98cdb6
GLib/GTK+ reference documentation project, see:
Packit 98cdb6
Packit 98cdb6
 http://www.gtk.org/rdp/
Packit 98cdb6
Packit 98cdb6
The GTK+ reference documentation is freely redistributable,
Packit 98cdb6
see the file COPYING for details.
Packit 98cdb6
Packit 98cdb6
Packit 98cdb6
REQUIREMENTS
Packit 98cdb6
============
Packit 98cdb6
Packit 98cdb6
To build the documentation, you must have the gtk-doc
Packit 98cdb6
package installed. To rebuild the template files,
Packit 98cdb6
you must have the current version of the GTK+
Packit 98cdb6
header files installed.
Packit 98cdb6
Packit 98cdb6
Packit 98cdb6
BUILD
Packit 98cdb6
=====
Packit 98cdb6
Packit 98cdb6
First, run configure to generate the makefiles for this
Packit 98cdb6
module. There is one option specific to this package
Packit 98cdb6
Packit 98cdb6
  --with-html-dir=DIR   top of installed HTML documentation tree
Packit 98cdb6
Packit 98cdb6
Packit 98cdb6
The Makefiles in the gdk/ and gtk/ subdirs each define three targets:
Packit 98cdb6
Packit 98cdb6
 templates:
Packit 98cdb6
  
Packit 98cdb6
  Scan the headers and merge the results with the current 
Packit 98cdb6
  template files
Packit 98cdb6
Packit 98cdb6
 sgml:
Packit 98cdb6
Packit 98cdb6
  Generate SGML files using the DocBook DTD from
Packit 98cdb6
  the template files
Packit 98cdb6
Packit 98cdb6
 html:
Packit 98cdb6
Packit 98cdb6
  Generate HTML from the SGML files.
Packit 98cdb6
Packit 98cdb6
To build the documentation, do:
Packit 98cdb6
Packit 98cdb6
 make sgml
Packit 98cdb6
 make html
Packit 98cdb6
Packit 98cdb6
You should only run the 'make templates' step if you
Packit 98cdb6
need to regenerate the templates for a more recent
Packit 98cdb6
version of the GTK+ sources.
Packit 98cdb6
Packit 98cdb6
INSTALLATION
Packit 98cdb6
============
Packit 98cdb6
Packit 98cdb6
 make install