test harness: improve catching of usage errors in script 'test-driver'

[platform/upstream/automake.git] / README

diff --git a/README b/README
index 0e23237..fdf25fa 100644 (file)
--- a/README
+++ b/README
@@ -1,54 +1,62 @@
-This is Automake, a Makefile generator.  It was inspired by the 4.4BSD
-make and include files, but aims to be portable and to conform to the
-GNU Coding Standards for Makefile variables and targets.
+This is Automake, a Makefile generator.  It aims to be portable and
+to conform to the GNU Coding Standards for Makefile variables and
+targets.
+
+See the INSTALL file for detailed information about how to configure
+and install Automake.

 
 Automake is a Perl script.  The input files are called Makefile.am.
 The output files are called Makefile.in; they are intended for use
 with Autoconf.  Automake requires certain things to be done in your
 configure.ac.
 
 
 Automake is a Perl script.  The input files are called Makefile.am.
 The output files are called Makefile.in; they are intended for use
 with Autoconf.  Automake requires certain things to be done in your
 configure.ac.
 

-Variable assignment lines in Makefile.am pull in defaults from various
-little *.am files.
+Automake comes with extensive documentation; please refer to it for
+more details about its purpose, features, and usage patterns.
+
+This package also includes the "aclocal" program, whose purpose is
+to generate an 'aclocal.m4' based on the contents of 'configure.ac'.
+It is useful as an extensible, maintainable mechanism for augmenting
+autoconf.  It is intended that other package authors will write m4
+macros which can be automatically used by aclocal.  The documentation
+for aclocal is currently found in the Automake manual.

 
 

-To use Automake, replace your Makefile.in files with Makefile.am
-files.  Read the documentation to see what to do.
+Automake has a test suite.  Use "make check" to run it.  For more
+information, see the file t/README.

 
 

-This package also includes the "aclocal" program.  aclocal is a
-program to generate an `aclocal.m4' based on the contents of
-`configure.ac'.  It is useful as an extensible, maintainable mechanism
-for augmenting autoconf.  It is intended that other package authors
-will write m4 macros which can be automatically used by aclocal.
+Automake has a page on the web.  See:

 
 

-Automake has a test suite.  Use
+       http://www.gnu.org/software/automake/

 
 

-       make check
+Automake also has three mailing lists:

 
 

-to run it.  Capture its output in case of failing tests.  For more
-information, please see the file tests/README.
+  * automake@gnu.org
+    For general discussions of Automake and its interactions with other
+    configuration/portability tools like Autoconf or Libtool.

 
 

-Automake has a page on the web.  See:
+  * bug-automake@gnu.org
+    Where to send bug reports and feature requests.

 
 

-       http://sources.redhat.com/automake/
+  * automake-patches@gnu.org
+    Where to send patches, and discuss the automake development process
+    and the  design of new features.

 
 

-The mailing list automake@gnu.org is for discussion of Automake and
-its interactions with other configuration/portability tools like
-Autoconf or Libtool.  Write to automake-request@gnu.org if you want to
-join.
+To obtain more information about these list, or to subscribe to them,
+refer to <http://www.gnu.org/software/automake/#mailinglists>

 
 

-Mail suggestions and bug reports to bug-automake@gnu.org, patches
-to automake-patches@gnu.org.
+New releases are announced to autotools-announce@gnu.org.  If you want to
+be informed, subscribe to that list by following the instructions at
+<http://lists.gnu.org/mailman/listinfo/autotools-announce>.

 
 

-New releases are announced to autotools-announce@gnu.org.  Write to
-autotools-announce-request@gnu.org if you want to receive them.
+For any copyright year range specified as YYYY-ZZZZ in this package,
+that the range specifies every single year in that closed interval.

 
 -----
 
 
 -----
 

-Copyright (C) 1994, 1995, 1996, 1997, 1998, 2001, 2003
-  Free Software Foundation, Inc.
+Copyright (C) 1994-2012 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
 
 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

-the Free Software Foundation; either version 3, or (at your option)
+the Free Software Foundation; either version 2, or (at your option)

 any later version.
 
 This program is distributed in the hope that it will be useful,
 any later version.
 
 This program is distributed in the hope that it will be useful,