diff README @ 739:dcda64966616 stable

README: polish the language so it reads better
author Greg Ward <greg@gerg.ca>
date Sat, 10 Aug 2013 17:30:44 -0400
parents d33fdd8202f3
children fa87604b359c
line wrap: on
line diff
--- a/README	Sat Aug 10 17:27:19 2013 -0400
+++ b/README	Sat Aug 10 17:30:44 2013 -0400
@@ -2,43 +2,41 @@
 Mutable History For Mercurial
 =============================
 
-
-Extends Mercurial feature related to Changeset Evolution
-
-This extension provides several commands to mutate history and deal with
-issues it may raise.
+This package supplies the ``evolve`` extension for Mercurial, which
+provides several commands to mutate history and deal with the
+resulting issues.
 
 It also:
 
     - enables the "changeset obsolescence" feature of Mercurial
-    - issues several warning messages when troubles appear in your repository
+    - issues several warning messages when trouble appears in your repository
 
-**These extensions are experimental and are not meant for production.**
+**This extension is experimental and not yet meant for production.**
 
-You can quickly enable it by adding the line below to the extensions
+You can enable it by adding the line below to the ``extensions``
 section of your hgrc::
 
-    evolve=PATH/TO/evolve.py
-
-But it's recommended to look at the doc in the first place.
+    evolve = PATH/TO/mutable-history/hgext/evolve.py
 
-See doc/ directory for details.
-
-Online version of the doc is available:
+We recommend reading the documentation first. An online version is
+available here:
 
     http://hg-lab.logilab.org/doc/mutable-history/html/
 
+Or see the ``doc/`` directory for a local copy.
+
 Contribute
 ==========
 
-The simplest way to contribute is to issue a pull request on Bitbucket.
+The simplest way to contribute is to issue a pull request on Bitbucket
+(https://bitbucket.org/marmoute/mutable-history).
 
 However, some cutting-edge changes may be found in a mutable repository hosted
 by logilab before they are published.
 
     http://hg-lab.logilab.org/wip/mutable-history/
 
-Make sure to check latest draft changeset before submitting new changesets.
+Be sure to check latest draft changeset before submitting new changesets.
 
 
 Changelog