maint: Update HACKING
[automake.git] / README
blobb71266907db2020f3009a3aa0953f65832ca38c5
1 This is Automake, a Makefile generator.  It aims to be portable and
2 to conform to the GNU Coding Standards for Makefile variables and
3 targets.
5 See the INSTALL file for detailed information about how to configure
6 and install Automake.
8 Automake is a Perl script.  The input files are called Makefile.am.
9 The output files are called Makefile.in; they are intended for use
10 with Autoconf.  Automake requires certain things to be done in your
11 configure.ac.
13 Automake comes with extensive documentation; please refer to it for
14 more details about its purpose, features, and usage patterns.
16 This package also includes the "aclocal" program, whose purpose is
17 to generate an 'aclocal.m4' based on the contents of 'configure.ac'.
18 It is useful as an extensible, maintainable mechanism for augmenting
19 autoconf.  It is intended that other package authors will write m4
20 macros which can be automatically used by aclocal.  The documentation
21 for aclocal is currently found in the Automake manual.
23 Automake has a test suite.  Use "make check" to run it.  For more
24 information, see the file t/README.
26 Automake has a page on the web.  See:
28         https://www.gnu.org/software/automake/
30 Automake also has three mailing lists:
32   * automake@gnu.org
33     For general discussions of Automake and its interactions with other
34     configuration/portability tools like Autoconf or Libtool.
36   * bug-automake@gnu.org
37     Where to send bug reports and feature requests.
39   * automake-patches@gnu.org
40     Where to send patches, and discuss the automake development process
41     and the  design of new features.
43 To obtain more information about these list, or to subscribe to them,
44 refer to <https://www.gnu.org/software/automake/#mailinglists>
46 New releases are announced to autotools-announce@gnu.org.  If you want to
47 be informed, subscribe to that list by following the instructions at
48 <https://lists.gnu.org/mailman/listinfo/autotools-announce>.
50 For any copyright year range specified as YYYY-ZZZZ in this package,
51 that the range specifies every single year in that closed interval.
53 -----
55 Copyright (C) 1994-2012 Free Software Foundation, Inc.
57 This program is free software; you can redistribute it and/or modify
58 it under the terms of the GNU General Public License as published by
59 the Free Software Foundation; either version 2, or (at your option)
60 any later version.
62 This program is distributed in the hope that it will be useful,
63 but WITHOUT ANY WARRANTY; without even the implied warranty of
64 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
65 GNU General Public License for more details.
67 You should have received a copy of the GNU General Public License
68 along with this program.  If not, see <https://www.gnu.org/licenses/>.