Added some simple build instructions.

Wed Aug 18 23:38:52 1999  Owen Taylor  <otaylor@redhat.com>

	* README: Added some simple build instructions.

Added a .cvsignore

diff --git a/docs/reference/.cvsignore b/docs/reference/.cvsignore
new file mode 100644 (file)
index 0000000..d7a28cc
--- /dev/null
+++ b/docs/reference/.cvsignore
@@ -0,0 +1,4 @@
+sgml
+html
+glib-decl-list.txt
+glib-unused.txt

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 081e1b256623eba67feae1e7ef862964f3892d67..2db3d6260cf6f27d701ccad06b903e37338f324e 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+Wed Aug 18 23:38:52 1999  Owen Taylor  <otaylor@redhat.com>
+
+       * README: Added some simple build instructions.
+
 Wed Aug 18 23:11:28 1999  Owen Taylor  <otaylor@redhat.com>
 
        * Import into CVS of glib-reference-1.1.3

diff --git a/docs/reference/README b/docs/reference/README
index d0aa59814198586047103457870d83a05c5edf2c..895028105a6fb528c80c6d52d698f83ab06d0123 100644 (file)
--- a/docs/reference/README
+++ b/docs/reference/README
@@ -12,3 +12,52 @@ GLib/GTK+ reference documentation project, see:
 The GLib 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 GLib
+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 for this module 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 GLib sources.
+
+
+INSTALLATION
+============
+
+ make install

diff --git a/docs/reference/glib/autogen.sh b/docs/reference/glib/autogen.sh
index 02d686035344eb2c3a5326aa19931c6a31c34cee..60bcd89f7abb9b19943c44c8bfcc070ea567d5b8 100755 (executable)
--- a/docs/reference/glib/autogen.sh
+++ b/docs/reference/glib/autogen.sh
@@ -42,6 +42,7 @@ if test -z "$*"; then
         echo "to pass any to it, please specify them on the $0 command line."
 fi
 
+aclocal $ACLOCAL_FLAGS
 automake -a $am_opt
 autoconf
 cd $ORIGDIR

diff --git a/docs/reference/glib/glib/ChangeLog b/docs/reference/glib/glib/ChangeLog
index 081e1b256623eba67feae1e7ef862964f3892d67..2db3d6260cf6f27d701ccad06b903e37338f324e 100644 (file)
--- a/docs/reference/glib/glib/ChangeLog
+++ b/docs/reference/glib/glib/ChangeLog
@@ -1,3 +1,7 @@
+Wed Aug 18 23:38:52 1999  Owen Taylor  <otaylor@redhat.com>
+
+       * README: Added some simple build instructions.
+
 Wed Aug 18 23:11:28 1999  Owen Taylor  <otaylor@redhat.com>
 
        * Import into CVS of glib-reference-1.1.3

diff --git a/docs/reference/glib/glib/README b/docs/reference/glib/glib/README
index d0aa59814198586047103457870d83a05c5edf2c..895028105a6fb528c80c6d52d698f83ab06d0123 100644 (file)
--- a/docs/reference/glib/glib/README
+++ b/docs/reference/glib/glib/README
@@ -12,3 +12,52 @@ GLib/GTK+ reference documentation project, see:
 The GLib 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 GLib
+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 for this module 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 GLib sources.
+
+
+INSTALLATION
+============
+
+ make install