diff options
Diffstat (limited to 'docs/reference/README')
| -rw-r--r-- | docs/reference/README | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/reference/README b/docs/reference/README new file mode 100644 index 000000000..024306be4 --- /dev/null +++ b/docs/reference/README @@ -0,0 +1,62 @@ +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 |