2009-11-15 Jb Evain <jbevain@novell.com>
[mcs.git] / README
blobfa6268f59b389cc78b1f645123090270c01c0b95
1 This contains code written in C# of Mono, it contains:
3         * Compilers written in C#
5         * Class Libraries.
7         * Regression Test Suites
9 To install this source code, look at the INSTALL file in the `mono'
10 package module which drives the compilation of this directory.
12 * Layout
13 ========
15         build/
16                 Rules, configuration and makefile components to build
17                 this module.
19         class/
20                 The class libraries.
22         errors/
23                 Sample programs that should generate errors by the C# compiler.
25         gmcs/
27                 The Mono C# compiler with Generics support.  This will
28                 become the default in Mono 2.0.
30         jay/
31                 Yacc-based parser generator.
33         mcs/
34                 The Mono C# compiler (1.0 + 2.0 minus generics).
36         tests/
37                 Regression test suite for the C# compiler
39         docs/
40                 Some notes on the compiler and the class libraries.
42         nant/
43                 A copy of nant source code, used during the build process
44                 on Windows.
46         tools/
47                 Various small development tools: CorCompare used to compare
48                 two assemblies for differences in the API;   TypeReflector is 
49                 a tool used to introspect types from assemblies from the 
50                 command line;  MonoStyle helps you keep your code indendented
51                 with the Mono programming style.
53 * Building Individual Directories
54 =================================
56 You can build individual components in the hierarchy by running the command
57 "make", and to install it use "make install".
59 By default, the 2.x profile is built, if you want to build the net 1.1 profile,
60 use the following command:
62         make PROFILE=net_1_1
64 And to install:
66         make PROFILE=net_1_1 install
68 To turn on verbose mode in the build (for example to diagnose a
69 problem), you can use the V=1 flag, like this:
71         make V=1
73 * Running Unit tests
74 ====================
76 You can run unit tests in individual components by running the command
77 "make run-test".  If you want to run tests for a different profile (say
78 'net_1_1')
80         make run-test PROFILE=net_1_1
82 If you want to only run the tests in a single fixture (say
83 'MonoTests.System.TypeTest'), you can use
85         make run-test TEST_HARNESS_FLAGS=/fixture:MonoTests.System.TypeTest
87 * Acknowledgements
88 ==================
90 Thanks a lot to Sergey Chaban for his help during the development of
91 the C# compiler.
93 * LICENSE
94 =========
96 The mcs C# compiler and monoresgen are licensed to you under the GPL, version 2.
97 The complete text of the GPL is in the 'COPYING' file.
99     Copyright (C) 2001-2002  Ximian, Inc.
101     This program is free software; you can redistribute it and/or modify
102     it under the terms of version 2 of the GNU General Public License as 
103     published by the Free Software Foundation.
105     This program is distributed in the hope that it will be useful,
106     but WITHOUT ANY WARRANTY; without even the implied warranty of
107     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
108     GNU General Public License for more details.
110     You should have received a copy of the GNU General Public License
111     along with this program; if not, write to the Free Software
112     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
114 The class libraries are licensed according to the following license:
116     Copyright (C) 2001-2002  Ximian, Inc.
118 Permission is hereby granted, free of charge, to any person obtaining a
119 copy of this software and associated documentation files (the "Software"),
120 to deal in the Software without restriction, including without limitation
121 the rights to use, copy, modify, merge, publish, distribute, sublicense,
122 and/or sell copies of the Software, and to permit persons to whom the
123 Software is furnished to do so, subject to the following conditions:
125 The above copyright notice and this permission notice shall be included
126 in all copies or substantial portions of the Software.
128 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
129 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
130 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
131 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
132 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
133 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
134 OTHER DEALINGS IN THE SOFTWARE.