[m-rev.] for review 3/3: Make a number of changes to the README.md file

Paul Bone paul at bone.id.au
Tue May 27 17:15:13 AEST 2014


On Tue, May 27, 2014 at 04:00:26PM +1000, Julien Fischer wrote:
>
> Hi Paul,
>
> On Tue, 27 May 2014, Paul Bone wrote:
>
>> Branches: master
>>
>> For review by anyone.
>>
>> ---
>>
>> Make a number of changes to the README.md file
>>
>> README.md:
>>    Reorder the list or README files to that they occur from most relevant
>>    to new users to least relevant.  In particular put commonly-used
>>    backends and platforms earlier in the list.
>>
>>    Provide some introductory text that introduce the user to the multiple
>>    backends available.
>>
>>    Add further links to more information such as the documentation.
>>
>>    Add text so that the file reads more natrually.
>
> s/natrually/naturally/ there

Okay.

>
> Could you please just post the final version of README.md: that would be
> easier to review than changes spread across three separate mails.
>

I've put it on github in my own clone of mercury, and github is formatting
it here:
https://github.com/PaulBone/mercury/blob/readme2/README.md

There's something odd with the spacing of things in the list but I don't
know and don't really want to know why it's doing that.  I was more
concerned with the content.


-- 
Paul Bone



More information about the reviews mailing list