X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=README;h=4d9a0876605b115789d9f9b9a0eb8f8ea6177142;hb=60349e4629dde05363b74687912d4a88540d42d7;hp=140c7ca4ca6f3da13a6928d05ec34867bc08ae91;hpb=955289a36e9cf3fa3135f745451d043db4589861;p=mono.git

diff --git a/README b/README
index 140c7ca4ca6..4d9a0876605 100644
--- a/README
+++ b/README
@@ -1,53 +1,81 @@
 
 This is Mono.
 
-A directory roadmap:
+1. Installation
+2. Using Mono
+3. Directory Roadmap
 
-	doc/
-		Contains documentation and the web site contents.
+1. Compilation and Installation
+===============================
 
-	mono/
-		The core of the executable.
+	If you obtained this package as an officially released tarball,
+	this is very simple, use configure and make:
 
-		metadata/
-			The library to deal with executables and libraries for
-			.NET
+		./configure --prefix=/usr/local
+		make
+		make install
 
-		dis/
-			CIL executable Disassembler
+	If you obtained this as a snapshot, you will need an existing
+	Mono installation.  To upgrade your installation do:
 
-		cli/
-			Common code for the JIT and the interpreter.
+		./autogen --prefix=/usr/local
+		make fullbuild
 
-		cil/
-			Common Intermediate Representation, XML
-			definition of the CIL bytecodes.
+2. Using Mono
+=============
 
-		interp/
-			Interpreter for CLI executables.
+	Once you have installed the software, you can run a few programs:
 
-* Using Mono
+	* runtime engine
 
-	Once you have installed the software, you can run a few programs:
+		mono program.exe
+	  or
+		mint program.exe
 
-		monodis program.exe
+	* C# compiler
 
-	That will dump the bytecodes for program.exe.  Monodis support
-	a number of options that dumps various metadata tables
-	(chapter 23 of the Partition III).
+		mcs program.cs
 
-	You can try the interpreter like this:
+	* CIL Disassembler
 
-		mono-int program.exe
+		monodis program.exe
+
+	See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
+	for further details.
 
+3. Directory Roadmap
+====================
+
+	doc/
+		Contains documentation and the web site contents.
 
+	mono/
+		The core of the Mono Runtime.
 
+		metadata/
+			The object system and metadata reader.
 
+		jit/
+			The Just in Time Compiler.
 
+		dis/
+			CIL executable Disassembler
 
+		cli/
+			Common code for the JIT and the interpreter.
 
+		io-layer/
+			The I/O layer and system abstraction for 
+			emulating the .NET IO model.
 
+		cil/
+			Common Intermediate Representation, XML
+			definition of the CIL bytecodes.
 
+		interp/
+			Interpreter for CLI executables.
 
+		arch/
+			Architecture specific portions.