From: Bruno Haible Date: Tue, 11 Jul 2006 11:59:13 +0000 (+0000) Subject: Mention where to put documentation. X-Git-Tag: cvs-readonly~2235 X-Git-Url: http://erislabs.org.uk/gitweb/?a=commitdiff_plain;h=9a21ae5eaf259e2b716e5a864e254793e2ef4e74;p=gnulib.git Mention where to put documentation. --- diff --git a/ChangeLog b/ChangeLog index 936f9dbc9..6d0d647d3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2006-07-11 Bruno Haible + + * README: Mention where to put documentation. + 2006-07-09 Paul Eggert * build-aux/depcomp, build-aux/install-sh: Sync from Automake. diff --git a/README b/README index 04bde18c0..72bde6dde 100644 --- a/README +++ b/README @@ -59,6 +59,12 @@ How to add a new module * If the module needs configure-time checks, write an autoconf macro for it in m4/.m4. See m4/README for details. * Write a module description modules/, based on modules/TEMPLATE. +* If the module contributes a section to the end-user documentation, + put this documentation in doc/.texi and add it to the "Files" + section of modules/. Most modules don't do this; they have only + documentation for the programmer (= gnulib user). Such documentation + usually goes into the lib/ source files. It may also go into doc/; + but don't add it to the module description in this case. * Add the module to the list in MODULES.html.sh. You can test that a module builds correctly with: