2003-10-07 Bernie Solomon <bernard@ugsolutions.com>
[mono.git] / README
1
2 This is Mono.
3
4 1. Installation
5 2. Using Mono
6 3. Directory Roadmap
7
8 1. Compilation and Installation
9 ===============================
10
11         If you obtained this package as an officially released tarball,
12         this is very simple, use configure and make:
13
14                 ./configure --prefix=/usr/local
15                 make
16                 make install
17
18         If you obtained this as a snapshot, you will need an existing
19         Mono installation.  To upgrade your installation do:
20
21                 ./autogen --prefix=/usr/local
22                 make fullbuild
23
24 2. Using Mono
25 =============
26
27         Once you have installed the software, you can run a few programs:
28
29         * runtime engine
30
31                 mono program.exe
32           or
33                 mint program.exe
34
35         * C# compiler
36
37                 mcs program.cs
38
39         * CIL Disassembler
40
41                 monodis program.exe
42
43         See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
44         for further details.
45
46 3. Directory Roadmap
47 ====================
48
49         doc/
50                 Contains documentation and the web site contents.
51
52         mono/
53                 The core of the Mono Runtime.
54
55                 metadata/
56                         The object system and metadata reader.
57
58                 jit/
59                         The Just in Time Compiler.
60
61                 dis/
62                         CIL executable Disassembler
63
64                 cli/
65                         Common code for the JIT and the interpreter.
66
67                 io-layer/
68                         The I/O layer and system abstraction for 
69                         emulating the .NET IO model.
70
71                 cil/
72                         Common Intermediate Representation, XML
73                         definition of the CIL bytecodes.
74
75                 interp/
76                         Interpreter for CLI executables.
77
78                 arch/
79                         Architecture specific portions.
80
81