diff options
author | Bruno Haible <bruno@clisp.org> | 2006-07-11 11:59:13 +0000 |
---|---|---|
committer | Bruno Haible <bruno@clisp.org> | 2006-07-11 11:59:13 +0000 |
commit | 9a21ae5eaf259e2b716e5a864e254793e2ef4e74 (patch) | |
tree | 921ccaaf8cb26da25a85b3a0f6b59b3c96092eb0 /README | |
parent | 8345137676d6b5efa46dc35f92722690206a95fc (diff) | |
download | gnulib-9a21ae5eaf259e2b716e5a864e254793e2ef4e74.tar.gz |
Mention where to put documentation.
Diffstat (limited to 'README')
-rw-r--r-- | README | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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: |