summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>1999-08-16 18:28:01 +0000
committerOwen Taylor <otaylor@src.gnome.org>1999-08-16 18:28:01 +0000
commit3ae5f29ce119bec2ba6c45c0064414d2e2a70796 (patch)
treed635bc48c84d7929871a1eed07404a892a87ff30 /docs
parentc8e989fb4e1cc1110d5089ac50a2be2fe9d724c4 (diff)
downloadglib-3ae5f29ce119bec2ba6c45c0064414d2e2a70796.tar.gz
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
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/.cvsignore4
-rw-r--r--docs/reference/ChangeLog4
-rw-r--r--docs/reference/README49
-rwxr-xr-xdocs/reference/glib/autogen.sh1
-rw-r--r--docs/reference/glib/glib/ChangeLog4
-rw-r--r--docs/reference/glib/glib/README49
6 files changed, 111 insertions, 0 deletions
diff --git a/docs/reference/.cvsignore b/docs/reference/.cvsignore
new file mode 100644
index 000000000..d7a28ccd0
--- /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 081e1b256..2db3d6260 100644
--- 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 d0aa59814..895028105 100644
--- 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 02d686035..60bcd89f7 100755
--- 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 081e1b256..2db3d6260 100644
--- 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 d0aa59814..895028105 100644
--- 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