2002-11-14 Martin Baulig <martin@gnome.org>

[mono.git] / README

diff --git a/README b/README
index 27f2ef4c497055e3e283d39f040337be9491ace8..07c2df049aff42b38c5d0ef97b478c39b4645af5 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,66 @@
-This is MonoNet.
 
-Ximian's portable implementation of .NET 
+This is Mono.
+
+Installation:
+
+       Read doc/download for installation instructions, 
+       or read the HTML version:
+
+               http://www.go-mono.com/download.html
+
+* Using Mono
+
+       Once you have installed the software, you can run a few programs:
+
+       * runtime engine
+
+               mono program.exe
+         or
+               mint program.exe
+
+       * C# compiler
+
+               mcs program.cs
+
+       * CIL Disassembler
+
+               monodis program.exe
+
+       See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
+       for further details.
+
+* A 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.
+
+