[m-rev.] Re: for review: Suggested readme patches

[Jonathan Morgan]

I've updated the patch, as I noticed it didn't completely remove the
references to binary packages in README.Cygwin.

Jon

Estimated hours taken: 0.75
Branches: main

Update README files.

README.Cygwin:
            Remove all references to the old Cygwin binary package, which
has been superseded by MinGW packages.

README.DotNet:
            Mention that the IL backend has been tested on .NET 1.1, as well
as 1.0.

README.MS-VisualC
            Mention that the Visual C backend may need the Platform SDK.


Index: README.Cygwin
===================================================================
RCS file: /home/mercury1/repository/mercury/README.Cygwin,v
retrieving revision 1.1
diff -u -u -r1.1 README.Cygwin
--- README.Cygwin    4 Oct 2005 10:34:36 -0000    1.1
+++ README.Cygwin    2 Mar 2006 02:47:50 -0000
@@ -7,8 +7,7 @@
 package.  We've tested the port on Windows XP SP2,
 but it should work on Windows 95, 98, ME, 2000 and NT.

-This file documents how to install the binary distribution of
-Mercury on Windows and how to build the source distribution
+This file documents how to build the source distribution
 of Mercury on Windows using Cygwin.  This installation will use the GNU
 C compiler by default.  If you want to use the Microsoft Visual C
 compiler, please see the file README.MS-VisualC.
@@ -30,17 +29,6 @@

     http://sources.redhat.com/cygwin/

-If you're going to use a binary distribution of Mercury for Windows,
-you need to make sure that you get a version of Cygwin that is
-compatible with the one that the binary distribution was compiled
-with.  This will normally be specified in the filename of the
-Mercury binary distribution.  For example, if the file name is
-mercury-0.9.1.pc-windows-cygwin-1.1.4.tar.gz then you need version
-1.1.4 of Cygwin.  Later versions may work also, however it is always
-possible that compatibility might break at some point.  Cygwin will
-create a file C:\cygwin\setup.txt that lists the versions of every
-package installed.
-
 Before continuing, check that you can run Cygwin and get a command line
 shell, and that `gcc' (the GNU C compiler) works.

@@ -50,16 +38,13 @@

 UNPACKING THE SOURCES

-After installing Cygwin, you should download the Mercury source or
-binary distribution, and unpack it.
+After installing Cygwin, you should download the Mercury source
+distribution, and unpack it.

 You should use Cygwin's tar program to unpack the Mercury distribution.
 From a cygwin command shell, use the `cd' command to change directory
-to the directory where you saved the source or binary distribution that
-you downloaded, and then use `tar zxf <filename>' to unpack it,
-where <filename> is the filename that you downloaded, e.g.
-mercury-compiler-<version>.tar.gz (for the source distribution), or
-mercury-<version>.i686-pc-cygwin-windows.tar.gz (for the binary
distribution).
+to the directory where you saved the distribution that you downloaded,
+and then use `tar zxf mercury-compiler-<version>.tar.gz' to unpack it.

 Note that other programs which understand tar.gz files (e.g. WinZip)
 may not be able to unpack them in the correct manner for use with Cygwin.
Index: README.DotNet
===================================================================
RCS file: /home/mercury1/repository/mercury/README.DotNet,v
retrieving revision 1.13
diff -u -u -r1.13 README.DotNet
--- README.DotNet    19 Feb 2004 06:38:48 -0000    1.13
+++ README.DotNet    2 Mar 2006 02:47:50 -0000
@@ -13,15 +13,16 @@
 compiler, and to pass more than 90% of the applicable tests in the Mercury
 test suite.

-The port is currently targetted at the Microsoft .NET Framework SDK version
1.
+The port is currently targeted at the Microsoft .NET Framework SDK versions
1
+and 1.1.  We recommend version 1.1.

 PREREQUISITES

 In order to try this system you will need

-    - The Microsoft .NET Framework SDK version 1, which can be
+    - The Microsoft .NET Framework SDK version 1 or 1.1, which can be
       downloaded for free from
-        <http://msdn.microsoft.com/net/>
+        <http://msdn.microsoft.com/netframework/>
       If you are an MSDN Universal subscriber you can also order
       CDs as part of your subscription.

@@ -35,7 +36,7 @@
           Microsoft Windows 2000 (SP 2 recommended)
           Microsoft Windows XP Professional

-      We have tested only on Windows 2000 (with SP 2).
+      We have tested only on Windows 2000 SP 2 and Windows XP SP2 Home.

     - Cygwin (see README.MS-Windows for how to install).
         The Mercury compiler still runs as a native compiler, built
@@ -70,7 +71,7 @@

       If you're reading this file from somewhere other than the
       Mercury distribution, try the Mercury homepage at
-          <http://www.cs.mu.oz.au/mercury/>
+          <http://www.cs.mu.oz.au/research/mercury/>

 -----------------------------------------------------------------------------

@@ -180,7 +181,7 @@

     http://www.cs.mu.oz.au/research/mercury/dotnet.html

-    http://msdn.microsoft.com/net/
+    http://msdn.microsoft.com/netframework/

     http://www.gotdotnet.com/

@@ -197,13 +198,11 @@
 Q. Does it work with other .NET Common Language Runtime implementations,
    such as Mono, Portable.Net, or Rotor?

-A. Some parts of the Mercury standard library implementation for .NET
-   are implemented using Managed C++ (Microsoft's extensions to C++
-   to support .NET).  So you need the Microsoft .NET SDK (which includes
-   the command-line version of Microsoft's C++ compiler) to build the
-   Mercury standard library in the `il' grade.
+A. In theory, it should be able to build with any ECMA-compliant IL
assembler
+   and C# compiler.  However, we have as of yet been unable to build the
+   standard library with any other .NET CLR implementations.

-   In theory, once you have done that, it should be possible to
+   Once the standard libray has been built it should be possible to
    build Mercury programs in the `il' grade using any ECMA-compliant
    IL assembler that provides the same command-line interface as
    the Microsoft ilasm.exe program, and to execute them using any
@@ -211,10 +210,9 @@
    tried using other .NET CLR implementations.


-Q. Does it work with versions of the Microsoft .NET Framework SDK greater
-   than 1.0?
+Q. Does it work with the Microsoft .NET Framework SDK 2.0?

-A. We don't know, because we've only tried it with version 1.0.
+A. We don't know, because we've only tried it with versions 1.0 and 1.1.
    If you have a later version, try it out yourself and let us know
    whether it works!

Index: README.MS-VisualC
===================================================================
RCS file: /home/mercury1/repository/mercury/README.MS-VisualC,v
retrieving revision 1.7
diff -u -u -r1.7 README.MS-VisualC
--- README.MS-VisualC    2 Apr 2004 08:53:39 -0000    1.7
+++ README.MS-VisualC    2 Mar 2006 02:47:50 -0000
@@ -7,6 +7,9 @@
 dependencies on Cygwin have been removed and cygwin is still required
 for installation (see README.MS-Windows).

+If you wish to use the Microsoft Visual C++ Toolkit 2003, or Microsoft
+Visual C++ Express 2005, you will require the Platform SDK.
+
 -----------------------------------------------------------------------------

 CONFIGURATION
@@ -50,6 +53,9 @@
    a) cvs -d :pserver:guest at cvs.mercury.cs.mu.oz.au:/home/mercury1/repository
login
    (password is guest)
    b) cvs -d :pserver:guest at cvs.mercury.cs.mu.oz.au:/home/mercury1/repository
co -r version-0_10_1 mercury
+
+   Alternatively, you can just run mmake realclean to create a fresh
+   version of the compiler.

    Then to use MSVC++ to build the compiler issue the following configure
    command.  (You must be able to run MSVC++ from command line):
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20060302/21331f3f/attachment.html>