2006-03-29 Robert Jordan <robertj@gmx.net>
[mono.git] / README
diff --git a/README b/README
index 6d257c99df310772741bdd2e00c2615f4aeab765..d9e5dbc678b17d1270351c8a46a0fe1410549726 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 
 This is Mono.
 
-1. Installation
-2. Using Mono
-3. Directory Roadmap
+       1. Installation
+       2. Using Mono
+       3. Directory Roadmap
 
 1. Compilation and Installation
 ===============================
@@ -17,23 +17,25 @@ This is Mono.
 
                  Available from: http://www.freedesktop.org/Software/pkgconfig
 
-               * glib 2.0
+               * glib 2.4
 
                  Available from: http://www.gtk.org/
 
-       Optional dependencies:
+       On Itanium, you must obtain libunwind:
+
+               http://www.hpl.hp.com/research/linux/libunwind/download.php4
 
-               * ICU library
+       On Solaris, make sure that you used GNU tar to unpack this package, as
+       Solaris tar will not unpack this correctly, and you will get strange errors.
 
-                 http://oss.software.ibm.com/icu/index.html
+       On Solaris, make sure that you use the GNU toolchain to build the software.
 
-                 You will need this one to get complete support for the international
-                 features of the .NET Framework.
+       Optional dependencies:
 
-               * Cairo and libgdiplus
+               * libgdiplus
 
                  If you want to get support for System.Drawing, you will need to get
-                 both Libgdiplus and Cairo.
+                 Libgdiplus.
 
     b. Building the Software
     ------------------------
@@ -45,13 +47,8 @@ This is Mono.
                make
                make install
 
-       Mono supports a JIT engine on x86, SPARC and PowerPC systems.
-       The various commands that ship with Mono default to the JIT engine
-       on x86 and SPARC, to turn it on for PPC systems, use the --with-jit=yes 
-       command line option to configure.
-
-       MacOS X Users: you will need to download the latest Boehm GC
-       Alpha release for garbage collection to work properly.
+       Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390, AMD64, ARM
+       and PowerPC systems.
 
        If you obtained this as a snapshot, you will need an existing
        Mono installation.  To upgrade your installation, unpack both
@@ -96,10 +93,11 @@ This is Mono.
 
        If you don't have a working Mono installation, an obvious choice
        is to install the latest released packages of 'mono' for your
-       distribution and try from the beginning.
+       distribution and running autogen.sh; make; make install in the
+       mono module directory.
 
-       You can also try a slightly more risky approach that should work
-       almost all the time.  
+       You can also try a slightly more risky approach: this may not work,
+       so start from the released tarball as detailed above.
 
        This works by first getting the latest version of the 'monolite'
        distribution, which contains just enough to run the 'mcs'
@@ -150,8 +148,6 @@ This is Mono.
        * runtime engine
 
                mono program.exe
-         or
-               mint program.exe
 
        * C# compiler
 
@@ -167,9 +163,6 @@ This is Mono.
 3. Directory Roadmap
 ====================
 
-       doc/
-               Contains the web site contents.
-
        docs/
                Technical documents about the Mono runtime.
 
@@ -182,7 +175,7 @@ This is Mono.
                metadata/
                        The object system and metadata reader.
 
-               jit/
+               mini/
                        The Just in Time Compiler.
 
                dis/
@@ -200,7 +193,7 @@ This is Mono.
                        definition of the CIL bytecodes.
 
                interp/
-                       Interpreter for CLI executables.
+                       Interpreter for CLI executables (obsolete).
 
                arch/
                        Architecture specific portions.
@@ -217,3 +210,4 @@ This is Mono.
 
                A directory that contains the Makefiles that link the
                mono/ and mcs/ build systems.
+