[xbuild] GetReferenceAssemblyPaths - add missing license header.

[mono.git] / mcs / README

diff --git a/mcs/README b/mcs/README
old mode 100755 (executable)
new mode 100644 (file)
index 40bbfc2..2a64e0f
--- a/mcs/README
+++ b/mcs/README
@@ -1,16 +1,26 @@
+This contains the C# components of the Mono project.
 
-This contains the Mono C# compiler as well as the Mono runtime
-library.
+       * Compilers written in C#
 
-See INSTALL.txt for a guide to building and installing mcs.
+       * Class Libraries.
 
-Layout:
+       * Regression Test Suites
+
+To install this source code, look at the INSTALL file in the `mono'
+package module which drives the compilation of this directory.
+
+* Layout
+========
+
+       build/
+               Rules, configuration and makefile components to build
+               this module.
 
        class/
-               Class libraries
+               The class libraries.
 
        errors/
-               Sample programs that should generate errors by the compiler.
+               Sample programs that should generate errors by the C# compiler.
 
        jay/
                Yacc-based parser generator.
@@ -19,7 +29,7 @@ Layout:
                The Mono C# compiler
 
        tests/
-               Sample tests 
+               Regression test suite for the C# compiler
 
        docs/
                Some notes on the compiler and the class libraries.
@@ -35,11 +45,48 @@ Layout:
                command line;  MonoStyle helps you keep your code indendented
                with the Mono programming style.
 
+* Building Individual Directories
+=================================
+
+You can build individual components in the hierarchy by running the command
+"make", and to install it use "make install".
+
+By default, the 2.x profile is built, if you want to build the net 1.1 profile,
+use the following command:
+
+       make PROFILE=net_1_1
+
+And to install:
+
+       make PROFILE=net_1_1 install
+
+To turn on verbose mode in the build (for example to diagnose a
+problem), you can use the V=1 flag, like this:
+
+       make V=1
+
+* Running Unit tests
+====================
+
+You can run unit tests in individual components by running the command
+"make run-test".  If you want to run tests for a different profile (say
+'net_1_1')
+
+       make run-test PROFILE=net_1_1
+
+If you want to only run the tests in a single fixture (say
+'MonoTests.System.TypeTest'), you can use
+
+       make run-test TEST_HARNESS_FLAGS=/fixture:MonoTests.System.TypeTest
+
+* Acknowledgements
+==================
 
 Thanks a lot to Sergey Chaban for his help during the development of
 the C# compiler.
 
-LICENSE
+* LICENSE
+=========
 
 The mcs C# compiler and monoresgen are licensed to you under the GPL, version 2.
 The complete text of the GPL is in the 'COPYING' file.