diff --git a/gramps/INSTALL b/gramps/INSTALL index 7526c41a4..5b2bdffdd 100644 --- a/gramps/INSTALL +++ b/gramps/INSTALL @@ -3,9 +3,9 @@ developers who may be adding functionality to the program, be sure to read the last section of this documen: "FINAL WORDS". SUPER-SHORT VERSION: -You should still be able to just run "./configure && make". But if you make -any significant changes, you may wish to run "./autogen.sh && make" to -regenerate everything. +You should be able to just run "./configure && make". But if you make any +significant changes or experience any problems, you may wish to run +"./autogen.sh && make" to regenerate everything. This will call aclocal if necessary, then automake, which creates Makefile.in from Makefile.am rules. Then it calls autoconf, which will @@ -23,7 +23,8 @@ with docbook-utils-0.6.9. There is a problem with 0.6.10, which seems to have some messed up dsl files. If you have difficulty building the HTML documentation with your version of jw, then remove "doc" from the SUBDIRS list in the top-level Makefile and send a report of where the failure was to -the gramps-devel list. +the gramps-devel list. This distribution is tested with the style sheets +and PNG support from the gnome-doc-tools-2-1 package. MORE INFO: Version and package info is now set in configure.in through a call to the AM_INIT_AUTOMAKE macro. The results are stored in variables diff --git a/gramps/README b/gramps/README index 40e485733..183651e75 100644 --- a/gramps/README +++ b/gramps/README @@ -1,4 +1,6 @@ Please read the COPYING file first. +If building from source, also read the INSTALL file (at least through the +"SUPER-SHORT VERSION") before going further. Requirements -------------------------------- @@ -17,14 +19,13 @@ Gramps documentation is supplied in the form of SGML files, which will be installed in the GNOME help path(*). Recent versions of Nautilus and Galeon can generate HTML on-the-fly documents from these. For more information on building HTML files (including info about packages that do and do not work -with the documentation) see the INSTALL file. To generate separate HTML -documentation: - -1) Ensure the following packages are installed: +with the documentation) see the INSTALL file. To generate HTML +documentation the following packages *MUST* installed: * db2html >= 0.6.9 (jw >= 1.1) to convert the SGML -> HTML * gnome-doc-tools-2-1 for the GNOME documentation style sheets The former is part of the docbook-utils package, the latter can be found -from the developer section at gnome.org. +from the developer section at gnome.org. (note that docbook-utils 0.6.10 is +buggy) One also needs png support for sgml, which should be a part of the gnome-doc-tools package. The /etc/sgml/catalog file should