X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=mcs%2FREADME;h=fa6268f59b389cc78b1f645123090270c01c0b95;hb=56d3f9a51ea24ffc53b384b01d607315bce17b4e;hp=3a0e1c7129e3c01a959ecdddb4ea8c5258b99357;hpb=526427e05bc922ce166fc48c3f0c2f4830606693;p=mono.git

diff --git a/mcs/README b/mcs/README
old mode 100755
new mode 100644
index 3a0e1c7129e..fa6268f59b3
--- a/mcs/README
+++ b/mcs/README
@@ -1,30 +1,97 @@
+This contains code written in C# of Mono, it contains:
 
-This contains the Mono C# compiler as well as the Mono runtime
-library.
+	* Compilers written in C#
 
-See INSTALL 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.
+
+	gmcs/
+
+		The Mono C# compiler with Generics support.  This will
+	  	become the default in Mono 2.0.
 
 	jay/
 		Yacc-based parser generator.
 
 	mcs/
-		The Mono C# compiler
+		The Mono C# compiler (1.0 + 2.0 minus generics).
 
 	tests/
-		Sample tests 
+		Regression test suite for the C# compiler
+
+	docs/
+		Some notes on the compiler and the class libraries.
+
+	nant/
+		A copy of nant source code, used during the build process
+		on Windows.
+
+	tools/
+		Various small development tools: CorCompare used to compare
+	 	two assemblies for differences in the API;   TypeReflector is 
+		a tool used to introspect types from assemblies from the 
+		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.