Wrote an INSTALL doc.
[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 on *NIX
17 ====================
18
19 mcs provides a set of makefiles which make it easy to build and install
20 mcs on *NIX systems like Linux or FreeBSD where mcs is already
21 installed.
22
23 To build the compiler and class libraries, run:
24
25     make -f makefile.gnu
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:
31
32     make -f makefile.gnu install
33
34 You can also specify a prefix into which the files will be installed:
35
36     make -f makefile.gnu install prefix=/opt
37
38 If you are tracking Mono's development, you may sometimes need to share
39 the compiled libraries with others. If you want to produce an easily
40 distributable tarball, run:
41
42     make -f makefile.gnu dist
43
44 Building mcs on Windows
45 =======================
46
47 It is also possible to build mcs on Windows using the Microsoft .NET
48 framework. This may be convenient if you do not have access to a working
49 mcs setup. To build the compiler and class libraries, run:
50
51     make
52
53 The libraries will be placed in the directory class/lib/ and the mcs compiler
54 executable in mcs/. They can then be copied to /usr/lib and /usr/bin or
55 wherever desired on the target system.
56