grammar updates
[mono.git] / README
diff --git a/README b/README
index 27f2ef4c497055e3e283d39f040337be9491ace8..4d9a0876605b115789d9f9b9a0eb8f8ea6177142 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,81 @@
-This is MonoNet.
 
-Ximian's portable implementation of .NET 
+This is Mono.
+
+1. Installation
+2. Using Mono
+3. Directory Roadmap
+
+1. Compilation and Installation
+===============================
+
+       If you obtained this package as an officially released tarball,
+       this is very simple, use configure and make:
+
+               ./configure --prefix=/usr/local
+               make
+               make install
+
+       If you obtained this as a snapshot, you will need an existing
+       Mono installation.  To upgrade your installation do:
+
+               ./autogen --prefix=/usr/local
+               make fullbuild
+
+2. 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.
+
+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.
+
+