test harness: improve catching of usage errors in script 'test-driver'
[platform/upstream/automake.git] / README
diff --git a/README b/README
index d1a1afa..fdf25fa 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,68 @@
-This is AutoMake, an experimental Makefile generator.  It was inspired
-by the 4.4BSD make and include files, but aims to be portable and to
-conform to the GNU 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.
 
-automake is a shell script.  The input files are called Makefile.am.
+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.
-
-Variable assignment lines in Makefile.am pull in defaults from various
-little *.am files.
-
-To use AutoMake, replace your Makefile.in files with Makefile.am
-files.  Since there's no documentation, look at the automake script
-and the examples provided for GNU m4 1.3 and fileutils 3.9 (along with
-patches you need to apply to those packages) and time 1.6.
-
-AutoMake is just a prototype at this point -- expect omissions and bugs.
-It uses only the programs that the GNU coding standards allow in
-configure scripts, because I wrote it keeping in mind the possibility
-of it becoming an Autoconf macro, so it would run at configure-time.
-That would slow configuration down a bit, but allow users to modify
-the Makefile.am without needing to fetch the AutoMake package.  And,
-the Makefile.in files wouldn't need to be distributed.  But all of
-AutoMake would.  So I might reimplement AutoMake in Perl, m4, or some
-other more appropriate language.
-
-- David MacKenzie <djm@gnu.ai.mit.edu>
+with Autoconf.  Automake requires certain things to be done in your
+configure.ac.
+
+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.
+
+Automake has a test suite.  Use "make check" to run it.  For more
+information, see the file t/README.
+
+Automake has a page on the web.  See:
+
+       http://www.gnu.org/software/automake/
+
+Automake also has three mailing lists:
+
+  * automake@gnu.org
+    For general discussions of Automake and its interactions with other
+    configuration/portability tools like Autoconf or Libtool.
+
+  * bug-automake@gnu.org
+    Where to send bug reports and feature requests.
+
+  * automake-patches@gnu.org
+    Where to send patches, and discuss the automake development process
+    and the  design of new features.
+
+To obtain more information about these list, or to subscribe to them,
+refer to <http://www.gnu.org/software/automake/#mailinglists>
+
+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>.
+
+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-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
+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,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.