readme: update advice about testsuite execution
[platform/upstream/automake.git] / README
1 This is Automake, a Makefile generator.  It was inspired by the 4.4BSD
2 make and include files, but aims to be portable and to conform to the
3 GNU Coding Standards for Makefile variables and targets.
4
5 Automake is a Perl script.  The input files are called Makefile.am.
6 The output files are called Makefile.in; they are intended for use
7 with Autoconf.  Automake requires certain things to be done in your
8 configure.ac.
9
10 Variable assignment lines in Makefile.am pull in defaults from various
11 little *.am files.
12
13 To use Automake, replace your Makefile.in files with Makefile.am
14 files.  Read the documentation to see what to do.
15
16 This package also includes the "aclocal" program.  aclocal is a
17 program to generate an `aclocal.m4' based on the contents of
18 `configure.ac'.  It is useful as an extensible, maintainable mechanism
19 for augmenting autoconf.  It is intended that other package authors
20 will write m4 macros which can be automatically used by aclocal.
21
22 Automake has a test suite.  Use
23
24         make check
25
26 to run it.  For more information, see the file tests/README.
27
28 Automake has a page on the web.  See:
29
30         http://www.gnu.org/software/automake/
31
32 The mailing list automake@gnu.org is for discussion of Automake and
33 its interactions with other configuration/portability tools like
34 Autoconf or Libtool.  Write to automake-request@gnu.org if you want to
35 join.
36
37 Mail suggestions and bug reports to bug-automake@gnu.org, patches
38 to automake-patches@gnu.org.
39
40 New releases are announced to autotools-announce@gnu.org.  Write to
41 autotools-announce-request@gnu.org if you want to receive them.
42
43 -----
44
45 Copyright (C) 1994, 1995, 1996, 1997, 1998, 2001, 2003, 2008, 2009, 2011
46   Free Software Foundation, Inc.
47
48 This program is free software; you can redistribute it and/or modify
49 it under the terms of the GNU General Public License as published by
50 the Free Software Foundation; either version 2, or (at your option)
51 any later version.
52
53 This program is distributed in the hope that it will be useful,
54 but WITHOUT ANY WARRANTY; without even the implied warranty of
55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
56 GNU General Public License for more details.
57
58 You should have received a copy of the GNU General Public License
59 along with this program.  If not, see <http://www.gnu.org/licenses/>.