2010-06-10 Jonathan Chambers <joncham@gmail.com>

[mono.git] / mcs / README

diff --git a/mcs/README b/mcs/README
index ef97cc14d5f7306c51035a16bb61c64059387cbc..fa6268f59b389cc78b1f645123090270c01c0b95 100644 (file)
--- a/mcs/README
+++ b/mcs/README
@@ -9,10 +9,8 @@ This contains code written in C# of Mono, it contains:
 To install this source code, look at the INSTALL file in the `mono'
 package module which drives the compilation of this directory.
 
-Layout:
-
-       bmcs/
-               New experimental Basic compiler.
+* Layout
+========
 
        build/
                Rules, configuration and makefile components to build
@@ -52,11 +50,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.