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 * Running Unit tests
  72 ====================
  73
  74 You can run unit tests in individual components by running the command
  75 "make run-test".  If you want to run tests for a different profile (say
  76 'net_2_0')
  77
  78         make run-test PROFILE=net_2_0
  79
  80 If you want to only run the tests in a single fixture (say
  81 'MonoTests.System.TypeTest'), you can use
  82
  83         make run-test TEST_HARNESS_FLAGS=/fixture:MonoTests.System.TypeTest
  84
  85 * Acknowledgements
  86 ==================
  87
  88 Thanks a lot to Sergey Chaban for his help during the development of
  89 the C# compiler.
  90
  91 * LICENSE
  92 =========
  93
  94 The mcs C# compiler and monoresgen are licensed to you under the GPL, version 2.
  95 The complete text of the GPL is in the 'COPYING' file.
  96
  97     Copyright (C) 2001-2002  Ximian, Inc.
  98
  99     This program is free software; you can redistribute it and/or modify
 100     it under the terms of version 2 of the GNU General Public License as
 101     published by the Free Software Foundation.
 102
 103     This program is distributed in the hope that it will be useful,
 104     but WITHOUT ANY WARRANTY; without even the implied warranty of
 105     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 106     GNU General Public License for more details.
 107
 108     You should have received a copy of the GNU General Public License
 109     along with this program; if not, write to the Free Software
 110     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 111
 112 The class libraries are licensed according to the following license:
 113
 114     Copyright (C) 2001-2002  Ximian, Inc.
 115
 116 Permission is hereby granted, free of charge, to any person obtaining a
 117 copy of this software and associated documentation files (the "Software"),
 118 to deal in the Software without restriction, including without limitation
 119 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 120 and/or sell copies of the Software, and to permit persons to whom the
 121 Software is furnished to do so, subject to the following conditions:
 122
 123 The above copyright notice and this permission notice shall be included
 124 in all copies or substantial portions of the Software.
 125
 126 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 127 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 128 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 129 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 130 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 131 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 132 OTHER DEALINGS IN THE SOFTWARE.
 133