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

[Jonathan Morgan]

On 3/6/06, Julien Fischer <juliensf at cs.mu.oz.au> wrote:
>
>
> On Wed, 1 Mar 2006, Jonathan Morgan wrote:
>
> > Below are some changes that I think need making to the README files.
>
> Thanks for that.  There were a bunch of other changes that needed to be
> made as well.  (BTW, in future could you please not send attachements as
> HTML.)



I was unaware that I was sending any attachments in HTML, as I hate doing
it.  I cannot see any attachments, or any options in gmail to disable
attachments.  What were these attachments?

Apart from that, the changes look good.

> Estimated hours taken: 0.5
> > Branches: main
> >
> > Update README files.
> >
> > README.Cygwin:
> >        Remove references to the old Cygwin binary package, which has
> >        been superseded by MinGW packages.
>
> Just because we now supply MinGW binaries doesn't mean we won't also
> supply ones for Cygwin (I know we didn't for 0.12 but that's mainly
> because we didn't get around to building any.)


Yes, that was an assumption - the only binary package I ever tried didn't
work anyway.


> README.DotNet:
> >       Mention that the IL backend has been tested on .NET 1.1, as well
> >       as 1.0.
>
> Done.
>
> > README.MS-VisualC
> >             Mention that the Visual C backend may need the Platform SDK.
>
> Done.
>
> Here's a revised diff incorporating the above changes plus a few others.
>
> Estimated hours taken: 0.5 (by Jonathan Morgan) + 0.2 (by me)
> Branches: main
>
> README.Cygwin:
>         Put angle brackets around URLs.
>
> README.Dotnet:
>         Put angle brackets around URLs and fix inconsistent indentation.
>
>         Mention that the IL backend has been tested on .NET 1.1, as well
>         as 1.0.
>
>         Fix the C# foreign_proc example so that it is valid Mercury.
>
> README.MS-VisualC:
>         Mention that the Visual C backend may need the Platform SDK.
>
>         Don't be so specific about the Mercury version.


I'd suggest making that change to README.MinGW as well, as in the following.


Index: README.MinGW
===================================================================
RCS file: /home/mercury1/repository/mercury/README.MinGW,v
retrieving revision 1.3
diff -u -u -r1.3 README.MinGW
--- README.MinGW    9 Dec 2005 14:16:18 -0000    1.3
+++ README.MinGW    6 Mar 2006 05:28:16 -0000
@@ -29,7 +29,7 @@

 2.  Open an MSYS session and unpack the source distribution with a command
     like:
-    tar -xvzf mercury-compiler-rotd-2005-09-29-unstable.tar.gz
+    tar -xvzf mercury-compiler-<VERSION>.tar.gz

 3.  cd into the new directory and run configure:


Jon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20060306/a820887a/attachment.html>