Update instructions
[mono.git] / mcs / INSTALL.txt
1 Basic Installation
2 ==================
3
4 The Mono project has developed mono, an x86-specific CL JIT compiler and
5 mint, a portable CLI interpreter. The build process of each of these
6 depends on nothing more than a C compiler, glib2 and libgc.
7
8 However, to provide a working runtime environment, these programs must
9 be supplemented by corlib, a CLR assembly to which they are closely
10 tied. This package provides the C# sources for corlib as well as some
11 additional assemblies and mcs, the Mono C# compiler.
12
13 To build this package, you must already have a C# compiler installed.
14 Build instructions for *NIX and Microsoft Windows follow.
15
16 Building mcs
17 ============
18
19 These instructions apply to both Unix and Windows.  You need GNU make
20 to build the software (on Windows, you will need for example the
21 Cygwin environment setup)
22
23 To build the compiler and class libraries, run:
24
25     make
26
27 The libraries will be placed in the directory class/lib/ and the mcs
28 compiler executable in mcs/.
29
30 To install them, run the following:
31
32     make install
33
34 The default is /usr/local, to change this configuration option type:
35
36     echo prefix=/your-prefix > build/config.make
37
38 If you are tracking Mono's development, you may sometimes need to share
39 the compiled libraries with others, you can do:
40
41     make monocharge
42
43 Or a light version:
44
45     make monocharge-lite
46
47
48 Configuration
49 -------------
50
51 If you want to change the configuration options for the build process,
52 place your configuration options in build/config.make
53
54 A list of variables that control the build are listed in the
55 build/config-default.make