2002-01-27 Gaurav Vaish <gvaish@iitk.ac.in>
[mono.git] / README
diff --git a/README b/README
index 27f2ef4c497055e3e283d39f040337be9491ace8..554141a51302ca8e5a7470313ef65b09ac6b52d5 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,45 @@
-This is MonoNet.
 
-Ximian's portable implementation of .NET 
+This is Mono.
+
+A directory roadmap:
+
+       doc/
+               Contains documentation and the web site contents.
+
+       mono/
+               The core of the executable.
+
+               metadata/
+                       The library to deal with executables and libraries for
+                       .NET
+
+               dis/
+                       CIL executable Disassembler
+
+               cli/
+                       Common code for the JIT and the interpreter.
+
+               cil/
+                       Common Intermediate Representation, XML
+                       definition of the CIL bytecodes.
+
+               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
+
+
+
+