X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=README;h=72bde6dde0da6c858938293f6b81c84b0c397b88;hb=31507e5ef8d0839ae990c00c08289803301c93fc;hp=04bde18c0e0a1936068b449344e28d76f999a0fc;hpb=98b3edaec794de4e5e8a0da62b49dba44e5446b5;p=gnulib.git 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: