maint: run "make update-copyright"
[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 Automake also has three mailing lists:
33
34   * automake@gnu.org
35     For general discussions of Automake and its interactions with other
36     configuration/portability tools like Autoconf or Libtool.
37
38   * bug-automake@gnu.org
39     Where to send bug reports and feature requests.
40
41   * automake-patches@gnu.org
42     Where to send patches, and discuss the automake development process
43     and the  design of new features.
44
45 To obtain more information about these list, or to subscribe to them,
46 refer to <http://www.gnu.org/software/automake/#mailinglists>
47
48 New releases are announced to autotools-announce@gnu.org.  If you want to
49 be informed, subscribe to that list by following the instructions at
50 <http://lists.gnu.org/mailman/listinfo/autotools-announce>.
51
52 -----
53
54 Copyright (C) 1994-2012 Free Software Foundation, Inc.
55
56 This program is free software; you can redistribute it and/or modify
57 it under the terms of the GNU General Public License as published by
58 the Free Software Foundation; either version 2, or (at your option)
59 any later version.
60
61 This program is distributed in the hope that it will be useful,
62 but WITHOUT ANY WARRANTY; without even the implied warranty of
63 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
64 GNU General Public License for more details.
65
66 You should have received a copy of the GNU General Public License
67 along with this program.  If not, see <http://www.gnu.org/licenses/>.