comparison 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
comparison
equal deleted inserted replaced
738:d33fdd8202f3 739:dcda64966616
1 ============================= 1 =============================
2 Mutable History For Mercurial 2 Mutable History For Mercurial
3 ============================= 3 =============================
4 4
5 5 This package supplies the ``evolve`` extension for Mercurial, which
6 Extends Mercurial feature related to Changeset Evolution 6 provides several commands to mutate history and deal with the
7 7 resulting issues.
8 This extension provides several commands to mutate history and deal with
9 issues it may raise.
10 8
11 It also: 9 It also:
12 10
13 - enables the "changeset obsolescence" feature of Mercurial 11 - enables the "changeset obsolescence" feature of Mercurial
14 - issues several warning messages when troubles appear in your repository 12 - issues several warning messages when trouble appears in your repository
15 13
16 **These extensions are experimental and are not meant for production.** 14 **This extension is experimental and not yet meant for production.**
17 15
18 You can quickly enable it by adding the line below to the extensions 16 You can enable it by adding the line below to the ``extensions``
19 section of your hgrc:: 17 section of your hgrc::
20 18
21 evolve=PATH/TO/evolve.py 19 evolve = PATH/TO/mutable-history/hgext/evolve.py
22 20
23 But it's recommended to look at the doc in the first place. 21 We recommend reading the documentation first. An online version is
24 22 available here:
25 See doc/ directory for details.
26
27 Online version of the doc is available:
28 23
29 http://hg-lab.logilab.org/doc/mutable-history/html/ 24 http://hg-lab.logilab.org/doc/mutable-history/html/
25
26 Or see the ``doc/`` directory for a local copy.
30 27
31 Contribute 28 Contribute
32 ========== 29 ==========
33 30
34 The simplest way to contribute is to issue a pull request on Bitbucket. 31 The simplest way to contribute is to issue a pull request on Bitbucket
32 (https://bitbucket.org/marmoute/mutable-history).
35 33
36 However, some cutting-edge changes may be found in a mutable repository hosted 34 However, some cutting-edge changes may be found in a mutable repository hosted
37 by logilab before they are published. 35 by logilab before they are published.
38 36
39 http://hg-lab.logilab.org/wip/mutable-history/ 37 http://hg-lab.logilab.org/wip/mutable-history/
40 38
41 Make sure to check latest draft changeset before submitting new changesets. 39 Be sure to check latest draft changeset before submitting new changesets.
42 40
43 41
44 Changelog 42 Changelog
45 ========= 43 =========
46 44