docs/reference/README

   1 This package contains the reference documentation
   2 for GLib. For more information about Glib,
   3 see:
   4
   5  http://www.gtk.org
   6
   7 For information about contributing to the
   8 GLib/GTK+ reference documentation project, see:
   9
  10  http://www.gtk.org/rdp/
  11
  12 The GLib reference documentation is freely redistributable,
  13 see the file COPYING for details.
  14
  15
  16 REQUIREMENTS
  17 ============
  18
  19 To build the documentation, you must have the gtk-doc
  20 package installed. To rebuild the template files,
  21 you must have the current version of the GLib
  22 header files installed.
  23
  24
  25 BUILD
  26 =====
  27
  28 First, run configure to generate the makefiles for this
  29 module. There is one option specific to this package
  30
  31   --with-html-dir=DIR   top of installed HTML documentation tree
  32
  33
  34 The Makefiles for this module define three targets:
  35
  36  templates:
  37
  38   Scan the headers and merge the results with the current
  39   template files
  40
  41  sgml:
  42
  43   Generate SGML files using the DocBook DTD from
  44   the template files
  45
  46  html:
  47
  48   Generate HTML from the SGML files.
  49
  50 To build the documentation, do:
  51
  52  make sgml
  53  make html
  54
  55 You should only run the 'make templates' step if you
  56 need to regenerate the templates for a more recent
  57 version of the GLib sources.
  58
  59
  60 INSTALLATION
  61 ============
  62
  63  make install