Add this for backwards compatibility
[mono.git] / mcs / README
1 This contains code written in C# of Mono, it contains:
2
3         * Compilers written in C#
4
5         * Class Libraries.
6
7         * Regression Test Suites
8
9 To install this source code, look at the INSTALL file in the `mono'
10 package module which drives the compilation of this directory.
11
12 * Layout
13 ========
14
15         bmcs/
16                 New experimental Basic compiler.
17
18         build/
19                 Rules, configuration and makefile components to build
20                 this module.
21
22         class/
23                 The class libraries.
24
25         errors/
26                 Sample programs that should generate errors by the C# compiler.
27
28         gmcs/
29
30                 The Mono C# compiler with Generics support.  This will
31                 become the default in Mono 2.0.
32
33         jay/
34                 Yacc-based parser generator.
35
36         mcs/
37                 The Mono C# compiler (1.0 + 2.0 minus generics).
38
39         tests/
40                 Regression test suite for the C# compiler
41
42         docs/
43                 Some notes on the compiler and the class libraries.
44
45         nant/
46                 A copy of nant source code, used during the build process
47                 on Windows.
48
49         tools/
50                 Various small development tools: CorCompare used to compare
51                 two assemblies for differences in the API;   TypeReflector is 
52                 a tool used to introspect types from assemblies from the 
53                 command line;  MonoStyle helps you keep your code indendented
54                 with the Mono programming style.
55
56 * Building Individual Directories
57 =================================
58
59 You can build individual components in the hierarchy by running the command
60 "make", and to install it use "make install".
61
62 If you need to build a given component on the 2.x profile, you must use 
63 the following command:
64
65         make PROFILE=net_2_0
66
67 And to install:
68
69         make PROFILE=net_2_0 install
70
71
72 * Acknowledgements
73 ==================
74
75 Thanks a lot to Sergey Chaban for his help during the development of
76 the C# compiler.
77
78 * LICENSE
79 =========
80
81 The mcs C# compiler and monoresgen are licensed to you under the GPL, version 2.
82 The complete text of the GPL is in the 'COPYING' file.
83
84     Copyright (C) 2001-2002  Ximian, Inc.
85
86     This program is free software; you can redistribute it and/or modify
87     it under the terms of version 2 of the GNU General Public License as 
88     published by the Free Software Foundation.
89
90     This program is distributed in the hope that it will be useful,
91     but WITHOUT ANY WARRANTY; without even the implied warranty of
92     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
93     GNU General Public License for more details.
94
95     You should have received a copy of the GNU General Public License
96     along with this program; if not, write to the Free Software
97     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
98
99 The class libraries are licensed according to the following license:
100
101     Copyright (C) 2001-2002  Ximian, Inc.
102
103 Permission is hereby granted, free of charge, to any person obtaining a
104 copy of this software and associated documentation files (the "Software"),
105 to deal in the Software without restriction, including without limitation
106 the rights to use, copy, modify, merge, publish, distribute, sublicense,
107 and/or sell copies of the Software, and to permit persons to whom the
108 Software is furnished to do so, subject to the following conditions:
109
110 The above copyright notice and this permission notice shall be included
111 in all copies or substantial portions of the Software.
112
113 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
114 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
115 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
116 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
117 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
118 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
119 OTHER DEALINGS IN THE SOFTWARE.
120