Mention where to put documentation.

diff --git a/ChangeLog b/ChangeLog
index 936f9dbc910e88378c262ed1cbc888f0ef9c49d6..6d0d647d3d9623214806d13e23f32ab8e3bcb32e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-07-11  Bruno Haible  <bruno@clisp.org>
+
+       * README: Mention where to put documentation.
+
 2006-07-09  Paul Eggert  <eggert@cs.ucla.edu>
 
        * build-aux/depcomp, build-aux/install-sh: Sync from Automake.

diff --git a/README b/README
index 04bde18c0e0a1936068b449344e28d76f999a0fc..72bde6dde0da6c858938293f6b81c84b0c397b88 100644 (file)
--- 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/<module>.m4. See m4/README for details.
 * Write a module description modules/<module>, based on modules/TEMPLATE.
+* If the module contributes a section to the end-user documentation,
+  put this documentation in doc/<module>.texi and add it to the "Files"
+  section of modules/<module>.  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: