Omit just-added *_REQUIRED macros
[autoconf.git] / README
blobf467f41013b014b4b5830e542d45826ac7105e81
1 -*- text -*-
3 Autoconf
5 Autoconf is an extensible package of M4 macros that produce shell
6 scripts to automatically configure software source code packages.
7 These scripts can adapt the packages to many kinds of UNIX-like
8 systems without manual user intervention.  Autoconf creates a
9 configuration script for a package from a template file that lists the
10 operating system features that the package can use, in the form of M4
11 macro calls.
13 Producing configuration scripts using Autoconf requires GNU M4 and
14 Perl.  You should install GNU M4 (version 1.4.8 or later is required;
15 1.4.16 or later is recommended) and Perl (5.006 or later) before
16 configuring Autoconf, so that Autoconf's configure script can find
17 them.  The configuration scripts produced by Autoconf are
18 self-contained, so their users do not need to have Autoconf (or GNU
19 M4, Perl, etc.).
21 You can get GNU M4 here:
23 https://ftp.gnu.org/gnu/m4/
25 The file INSTALL should be distributed with packages that use
26 Autoconf-generated configure scripts and Makefiles that conform to the
27 GNU coding standards.  The package's README can just give an overview
28 of the package, where to report bugs, and a pointer to INSTALL for
29 instructions on compilation and installation.  This removes the need
30 to maintain many similar sets of installation instructions.
32 Be sure to read BUGS and INSTALL.
34 Mail suggestions to autoconf@gnu.org, report bugs to
35 bug-autoconf@gnu.org, and submit patches to autoconf-patches@gnu.org.
36 All changes can be tracked at the read-only autoconf-commit@gnu.org.
37 Always include the Autoconf version number, which you can get by
38 running 'autoconf --version'.  Archives of bug-autoconf@gnu.org can be
39 found in <https://lists.gnu.org/archive/html/bug-autoconf/>, and
40 similarly for the other mailing lists.
42 Licensing
43 =========
44 Autoconf is released under the General Public License version 3 (GPLv3+).
45 Additionally, Autoconf includes a licensing exception in some of its
46 source files; see the respective copyright notices for how your
47 project is impacted by including scripts generated by Autoconf, and the
48 COPYING.EXCEPTION file for the exception in terms of the Additional
49 Permissions as described in section 7 of GPLv3.
51 For more licensing information, see
52 <https://www.gnu.org/licenses/gpl-faq.html> and
53 <https://www.gnu.org/licenses/exceptions.html>.
55 For any copyright year range specified as YYYY-ZZZZ in this package
56 note that the range specifies every single year in that closed interval.
58 GNU Project notice
59 ==================
60 Autoconf is part of the GNU Operating System, developed by the GNU Project.
62 If you are the author of an awesome program and want to join us in
63 writing Free (libre) Software, please consider making it an official
64 GNU program and become a GNU Maintainer.  Instructions on how to do
65 this are here:
66   https://www.gnu.org/help/evaluation
68 Don't have a program to contribute?  Look at all the other ways to help:
69   https://www.gnu.org/help/help.html
71 And to learn more about Free (libre) Software in general, please read
72 and share this page:
73   https://gnu.org/philosophy/free-sw.html
75 We are looking forward to hacking with you!
77 -----
79 Copyright (C) 1992-1994, 1998, 2000-2017, 2020-2022 Free Software
80 Foundation, Inc.
82 Copying and distribution of this file, with or without modification,
83 are permitted in any medium without royalty provided the copyright
84 notice and this notice are preserved.  This file is offered as-is,
85 without warranty of any kind.