Flush

[mono.git] / README

diff --git a/README b/README
index 69d58ece49f4cfb5bb7f0a2ffd5b721ae6facd62..4d9a0876605b115789d9f9b9a0eb8f8ea6177142 100644 (file)
--- a/README
+++ b/README
@@ -1,50 +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
+
+       * C# compiler
+
+               mcs program.cs
+
+       * CIL Disassembler
 
                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).
+       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.
 
-       You can try the interpreter like this:
+       mono/
+               The core of the Mono Runtime.
 
-               mono-int program.exe
+               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.