03d7488588aba2495eef8c699e8ac5021bf15d87
[unifdef.git] / INSTALL
1 unifdef installation instructions
2 ---------------------------------
3
4 Dependencies:
5  * unifdef is mostly ANSI C, with a few unixisms
6  * unifdefall is a Unix shell script
7  * the manual uses the nroff mdoc macros
8  * the support and test scripts are Unix shell scripts
9
10 To build on Unix, type `make`. You can adjust the compilation options
11 using the POSIX standard CFLAGS and LDFLAGS make variables.
12
13 To install in your home directory, type `make install`
14 or to install in /usr type `make prefix=/usr install`.
15 See the start of the Makefile for the install location
16 variables.
17
18 The win32 subdirectory contains build files for MinGW and Visual
19 Studio 2010 which make use of the FreeBSD code plus some other
20 portability wrappers.
21
22 To build with MinGW, type `mingw32-make -f win32/Makefile.mingw`.
23
24 Unlike the Unix Makefile, the Windows builds do not automatically
25 create or update version.h. The release tar and zip files include a
26 pre-generated version.h but the git repository does not. To build from
27 a git clone you need a Unix shell environment, which you can get as
28 part of GitHub for Windows - http://windows.github.com/
29 To update version.h, right-click on the fanf2/unifdef repository and
30 select "open a shell here", then type `sh scripts\reversion.sh`.
31
32 We assume Unix provides the BSD err.h functions and C99 stdbool.h. The
33 FreeBSD subdirectory has copies of err.c and getopt.c for systems such
34 as Windows that don't have them built in.
35
36 - end -