* modules/configmake (Makefile.am): Make configmake.h depend on

[gnulib.git] / README

diff --git a/README b/README
index 54cc04e..72bde6d 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,9 @@ Gnulib
 Gnulib is intended to be the canonical source for most of the important
 "portability" and/or common files for GNU projects.  These are files
 intended to be shared at the source level; Gnulib is not a library meant
-to be installed and linked against.
+to be installed and linked against.  Unlike most projects, Gnulib does
+not normally generate a source tarball distribution; instead, developers
+should just grab modules directly from the repository.
 
 While portability across operating systems is not one of GNU's primary
 goals, it has helped introduce many people to the GNU system, and is
@@ -57,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:
@@ -195,7 +203,7 @@ http://savannah.gnu.org/projects/gnulib.
 
 
 -----
-Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
+Copyright (C) 2001, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by