Updated ChangeLog

[mono.git] / README

diff --git a/README b/README
index efd08e59aed0ce5d67f10de4ad562616fa104f3c..4d9a0876605b115789d9f9b9a0eb8f8ea6177142 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,62 @@
 
 This is Mono.
 
-A directory roadmap:
+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 executable.
+               The core of the Mono Runtime.
 
                metadata/
-                       The library to deal with executables and libraries for
-                       .NET
+                       The object system and metadata reader.
+
+               jit/
+                       The Just in Time Compiler.
 
                dis/
                        CIL executable Disassembler
@@ -19,6 +64,10 @@ A directory roadmap:
                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.
@@ -26,18 +75,7 @@ A directory roadmap:
                interp/
                        Interpreter for CLI executables.
 
-* Using Mono
-
-       Once you have installed the software, you can run a few programs:
-
-               monodis program.exe
-
-       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).
-
-       You can try the interpreter like this:
-
-               mint program.exe
+               arch/
+                       Architecture specific portions.