1Note
2----
3These are generic installation instructions.
4
5These instructions assume that Watcom is the default compiler of this software
6package. If this software supports additional compilers, aside from Watcom, it
7is very likely that this build system is not the default. In this case, it may
8well be possible that some files have different names than assumed in these
9instructions. Please consult the software ditribution's documentation for more
10information on this topic.
11
12Configuration
13-------------
14Before you can compile anything, create a file called CONFIG.MIF in the
15distribution's base directory. It is best to copy the template below out of
16this file and modify it to fit your setup.
17
18In most cases, you just want to change the installation target directories
19"bindir", "includedir" and "libdir" to your standard binary, header and
20library directories. If you want to install the software manually and don't
21want to set any other options, you can just leave the whole file blank.
22
23There are numerous possibilities to configure other aspects of the
24distribution using the CONFIG.MIF file. You can redefine any variable of the
25distribution's original Makefile, any standard wmake variable (CFLAGS, LDFLAGS
26and the like) or specify another system type using the SYSTEM variable.
27
28Installation
29------------
30After configuration, run "wmake" to build the software.
31
32If you like to automatically install the software, run "wmake install".
33
34For manual installation, you have to consult the software distribution's
35documentation for information.
36
37After the installation, you can run "wmake clean" to delete any files created
38during compilation.
39
40If you must, you can even run "wmake distclean" to clean up any additionally
41created files and bring back your source directory into the same state it was
42after unpacking the distribution archive.
43
44Uninstallation
45--------------
46You can automatically delete all installed files by running "wmake uninstall".
47Note that any files created after installation are being left on the device.
48
49Debugging
50---------
51To enable debugging using the Watcom debugger, add the following line to your
52CONFIG.MIF file:
53
54debug = yes
55
56This will recompile all source files with source-level debugging enabled and
57instructs the linker to include debugging information. Be careful with the
58SYSTEM setting in your CONFIG.MIF file, though. Only some extenders are
59supported by the Watcom debugger. Some distributions may have defined a
60non-compatible extender by default, which you must override by specifying
61your own.
62
63CONFIG.MIF Template
64-------------------
65# Makefile configuration file
66# Lines starting with a '#' are comments.
67# Variables in capital letters are distribution-specific. Be careful when
68# changing any of these!
69
70# If debug is set to "yes", the compiler and linker are instructed to
71# include debug information with the compiled objects and executables.
72# Default: no
73# This example enables debugging.
74#debug = yes
75
76# "bindir" is the target directory for binary (.exe) files.
77# Default: current directory
78#bindir = c:\bin
79
80# "includedir" is the target directory for header (.h) files.
81# Default: current directory
82#includedir = c:\include
83
84# "libdir" is the target directory for library (.lib) files.
85# Default: current directory
86#libdir = c:\lib
87
88# SYSTEM defines the target system.
89# Default: (distribution specified)
90#SYSTEM =
91
92# CFLAGS defines any parameters that should be passed to the C compiler.
93# Default: (distribution specified)
94#CFLAGS +=
95
96# CXXFLAGS defines any parameters that should be passed to the C++ compiler.
97# Default: (distribution specified)
98#CXXFLAGS +=
99
100# CPPFLAGS defines preprocessing directives passed to the C/C++ compilers.
101# Default: (distribution specified)
102#CPPFLAGS +=
103
104# LDFLAGS defines any parameters passed to the linker.
105# Default: (distribution specified)
106#LDFLAGS +=
107
108# LIBFLAGS defines any parameters passed to the library manager.
109# Default: (distribution specified)
110#LIBFLAGS +=
111
112# ZIPFLAGS defines any parameters passed to the archive manager.
113# Default: (distribution specified)
114#ZIPFLAGS =
115