Wrote an INSTALL doc.

svn path=/trunk/mcs/; revision=6197

diff --git a/mcs/ChangeLog b/mcs/ChangeLog
index 40f35ce7568b8e85ea8f2364181a59f669dfc705..5d66d13da461cd178ea8d0b530b113065f067610 100644 (file)
--- a/mcs/ChangeLog
+++ b/mcs/ChangeLog
@@ -1,3 +1,8 @@
+2002-07-26  Alp Toker  <alp@atoker.com>
+
+       * INSTALL: Wrote a guide to mcs installation.
+       * README: Updated to reflect the new INSTALL guide.
+
 2002-07-23  Alp Toker  <alp@atoker.com>
 
        * makefile.gnu: Added an install target (which sets permissions and

diff --git a/mcs/INSTALL b/mcs/INSTALL
new file mode 100644 (file)
index 0000000..954fdca
--- /dev/null
+++ b/mcs/INSTALL
@@ -0,0 +1,56 @@
+Basic Installation
+==================
+
+The Mono project has developed mono, an x86-specific CL JIT compiler and
+mint, a portable CLI interpreter. The build process of each of these
+depends on nothing more than a C compiler, glib2 and libgc.
+
+However, to provide a working runtime environment, these programs must
+be supplemented by corlib, a CLR assembly to which they are closely
+tied. This package provides the C# sources for corlib as well as some
+additional assemblies and mcs, the Mono C# compiler.
+
+To build this package, you must already have a C# compiler installed.
+Build instructions for *NIX and Microsoft Windows follow.
+
+Building mcs on *NIX
+====================
+
+mcs provides a set of makefiles which make it easy to build and install
+mcs on *NIX systems like Linux or FreeBSD where mcs is already
+installed.
+
+To build the compiler and class libraries, run:
+
+    make -f makefile.gnu
+
+The libraries will be placed in the directory class/lib/ and the mcs
+compiler executable in mcs/.
+
+To install them, run:
+
+    make -f makefile.gnu install
+
+You can also specify a prefix into which the files will be installed:
+
+    make -f makefile.gnu install prefix=/opt
+
+If you are tracking Mono's development, you may sometimes need to share
+the compiled libraries with others. If you want to produce an easily
+distributable tarball, run:
+
+    make -f makefile.gnu dist
+
+Building mcs on Windows
+=======================
+
+It is also possible to build mcs on Windows using the Microsoft .NET
+framework. This may be convenient if you do not have access to a working
+mcs setup. To build the compiler and class libraries, run:
+
+    make
+
+The libraries will be placed in the directory class/lib/ and the mcs compiler
+executable in mcs/. They can then be copied to /usr/lib and /usr/bin or
+wherever desired on the target system.
+

diff --git a/mcs/INSTALL.txt b/mcs/INSTALL.txt
new file mode 100644 (file)
index 0000000..954fdca
--- /dev/null
+++ b/mcs/INSTALL.txt
@@ -0,0 +1,56 @@
+Basic Installation
+==================
+
+The Mono project has developed mono, an x86-specific CL JIT compiler and
+mint, a portable CLI interpreter. The build process of each of these
+depends on nothing more than a C compiler, glib2 and libgc.
+
+However, to provide a working runtime environment, these programs must
+be supplemented by corlib, a CLR assembly to which they are closely
+tied. This package provides the C# sources for corlib as well as some
+additional assemblies and mcs, the Mono C# compiler.
+
+To build this package, you must already have a C# compiler installed.
+Build instructions for *NIX and Microsoft Windows follow.
+
+Building mcs on *NIX
+====================
+
+mcs provides a set of makefiles which make it easy to build and install
+mcs on *NIX systems like Linux or FreeBSD where mcs is already
+installed.
+
+To build the compiler and class libraries, run:
+
+    make -f makefile.gnu
+
+The libraries will be placed in the directory class/lib/ and the mcs
+compiler executable in mcs/.
+
+To install them, run:
+
+    make -f makefile.gnu install
+
+You can also specify a prefix into which the files will be installed:
+
+    make -f makefile.gnu install prefix=/opt
+
+If you are tracking Mono's development, you may sometimes need to share
+the compiled libraries with others. If you want to produce an easily
+distributable tarball, run:
+
+    make -f makefile.gnu dist
+
+Building mcs on Windows
+=======================
+
+It is also possible to build mcs on Windows using the Microsoft .NET
+framework. This may be convenient if you do not have access to a working
+mcs setup. To build the compiler and class libraries, run:
+
+    make
+
+The libraries will be placed in the directory class/lib/ and the mcs compiler
+executable in mcs/. They can then be copied to /usr/lib and /usr/bin or
+wherever desired on the target system.
+

diff --git a/mcs/README b/mcs/README
index c3d344552c28e245965f95e1b51ead147aa69b32..848d3d9261462d8c8e961e1eaac26239d92d77b8 100755 (executable)
--- a/mcs/README
+++ b/mcs/README
@@ -2,6 +2,8 @@
 This contains the Mono C# compiler as well as the Mono runtime
 library.
 
+See INSTALL for a guide to building and installing mcs.
+
 Layout:
 
        class/