* Various cleanups for release.
[make.git] / README.template
blob1822174b32761ca2001f5e05cff7a6a32c695b8b
1 This directory contains the %VERSION% release of GNU Make.
3 See the file NEWS for the user-visible changes from previous releases.
4 In addition, there have been bugs fixed.
6 Please check the system-specific notes below for any caveats related to
7 your operating system.
9 For general building and installation instructions, see the file INSTALL.
11 If you need to build GNU Make and have no other `make' program to use,
12 you can use the shell script `build.sh' instead.  To do this, first run
13 `configure' as described in INSTALL.  Then, instead of typing `make' to
14 build the program, type `sh build.sh'.  This should compile the program
15 in the current directory.  Then you will have a Make program that you can
16 use for `./make install', or whatever else.
18 Some systems' Make programs are broken and cannot process the Makefile for
19 GNU Make.  If you get errors from your system's Make when building GNU
20 Make, try using `build.sh' instead.
22 GNU make is fully documented in the GNU Make manual, which is contained
23 in this distribution as the file make.texinfo.  You can also find
24 on-line and preformatted (PostScript and DVI) versions at the FSF's web
25 site.  There is information there about ordering hardcopy documentation.
27   http://www.gnu.org/
28   http://www.gnu.org/doc/doc.html
29   http://www.gnu.org/manual/manual.html
31 You can also find the latest versions of GNU Make from there.
33 You can send GNU make bug reports to bug-make@gnu.org.  Please see the
34 section of the GNU make manual entitled `Problems and Bugs' for
35 information on submitting useful and complete bug reports.
37 If you need help using GNU make, try these forums:
39   help-make@gnu.org
40   help-utils@gnu.org
41   news:gnu.utils.help
42   news:gnu.utils.bug
44 Also:
46   - See README.customs for details on integrating GNU make with the
47     Customs distributed build environment from the Pmake distribution.
49   - See README.W32 for details about GNU Make on Windows NT, 95, or 98.
51   - See README.Amiga for details about GNU Make on AmigaDOS.
53   - See README.DOS for compilation instructions on MS-DOS and MS-Windows
54     using DJGPP tools.
56     A precompiled binary of the MSDOS port of GNU Make is available as part
57     of DJGPP; see the WWW page http://www.delorie.com/djgpp/ for more
58     information.
61 GNU Make is free software.  See the file COPYING for copying conditions.
64 System-specific Notes
65 ---------------------
67 It has been reported that the XLC 1.2 compiler on AIX 3.2 is buggy such
68 that if you compile make with `cc -O' on AIX 3.2, it will not work correctly.
69 It is said that using `cc' without `-O' does work.
71 One area that is often a problem in configuration and porting is the code
72 to check the system's current load average.  To make it easier to test and
73 debug this code, you can do `make check-loadavg' to see if it works
74 properly on your system.  (You must run `configure' beforehand, but you
75 need not build Make itself to run this test.)
77 Another potential source of porting problems is the configure support
78 enabling GNU make to access large files (LFS) on those operating systems
79 that support them.  Please report any bugs that you find in this area.
80 If you run into difficulties, then as a workaround you should be able to
81 disable LFS by adding the `--disable-largefile' option to the
82 `configure' script.