README
changeset 2095 1c6bb9c117fc
parent 2094 e906723ab99f
child 2097 c99e926d465a
equal deleted inserted replaced
2094:e906723ab99f 2095:1c6bb9c117fc
     1 =============================
     1 =============================
     2 Mutable History For Mercurial
     2 Mutable History For Mercurial
     3 =============================
     3 =============================
     4 
     4 
       
     5 Evolve Extension
       
     6 =================
       
     7 
     5 This package supplies the ``evolve`` extension for Mercurial,
     8 This package supplies the ``evolve`` extension for Mercurial,
     6 
     9 
     7 **The full implementation of the changeset evolution concept is still in
    10 **The full implementation of the changeset evolution concept is still in
     8 progress.**  Please subscribe to the `evolve-testers mailing list <https://www.mercurial-scm.org/mailman/listinfo/evolve-testers>`_ to stay up to date with changes.
    11 progress.**  Please subscribe to the `evolve-testers mailing list <https://www.mercurial-scm.org/mailman/listinfo/evolve-testers>`_ to stay up to date with changes.
     9 
    12 
    17    your repository,
    20    your repository,
    18 
    21 
    19  * provides a ``hg evolve`` command to deal with such "troubles".
    22  * provides a ``hg evolve`` command to deal with such "troubles".
    20    issues.
    23    issues.
    21 
    24 
    22 You can enable it by adding the line below to the ``extensions``
    25 Install
    23 section of your hgrc::
    26 -------
    24 
    27 
    25     evolve = PATH/TO/evolve-main/hgext3rd/evolve/
    28 You can install the latest evolution version usin pip::
       
    29 
       
    30     $ pip install --user hg-evolve
       
    31 
       
    32 Then just enable it in you hgrc::
       
    33 
       
    34     $ hg config --edit # adds the two line below:
       
    35     [extensions]
       
    36     evolve =
    26 
    37 
    27 We recommend reading the documentation first. An online version is
    38 We recommend reading the documentation first. An online version is
    28 available here:
    39 available here:
    29 
    40 
    30     https://www.mercurial-scm.org/doc/evolution/
    41     https://www.mercurial-scm.org/doc/evolution/
    31 
    42 
    32 Or see the ``doc/`` directory for a local copy.
    43 Local Install
    33 
    44 -------------
    34 topic
    45 
    35 =====
    46 To install a local version from source::
    36 
    47 
    37 Topics are an experiment to see if maybe the workflow defined by git
    48     $ hg clone https://www.mercurial-scm.org/repo/evolve/
    38 branches and hg bookmarks is only partially what users want - perhaps
    49     $ cd evolve
    39 something that feels more like a traditional VCS branch is right, but
    50     $ make install-home
    40 that it should "dissolve" upon being finished. This extension exists
    51 
    41 to be a sandbox for that experimentation.
    52 Then just enable it in you hgrc::
    42 
    53 
    43 # install
    54     $ hg config --edit # adds the two line below:
    44 
       
    45 Enable topics like any mercurial extension: download the source code to a
       
    46 local directory, and add that directory to your `.hgrc`:
       
    47 
       
    48     [extensions]
    55     [extensions]
    49     topics=PATH/TO/evolve-main/hgext3rd/topic/
    56     evolve =
    50 
    57 
    51 # help
    58 Documentation lives in ``doc/``.
    52 
    59 
    53 See 'hg help -e topic' for a generic help.
    60 Topic Extension
    54 See 'hg help topics' and 'hg help stack' for help on specific commands.
    61 ================
    55 See the 'tests/test-topic-tutorial.t' file for a quick tutorial.
    62 
       
    63 This packages also provides the ``topic`` extensions. It implements a new
       
    64 experimental concept to provide lightweight feature branches for the mutable
       
    65 parts of the history. The experiments is still at an early stage and have
       
    66 significant usability and performance issues.
       
    67 
       
    68 enable topic
       
    69 ------------
       
    70 
       
    71 The topic extensions is included in the evolve package. See the install instruction for evolve.
       
    72 
       
    73 Then enable it in you configuration::
       
    74 
       
    75     $ hg config --edit # adds the two line below:
       
    76     [extensions]
       
    77     topics =
       
    78 
       
    79 help
       
    80 ----
       
    81 
       
    82  * See 'hg help -e topic' for a generic help.
       
    83  * See 'hg help topics' and 'hg help stack' for help on specific commands.
       
    84  * See the 'tests/test-topic-tutorial.t' file for a quick tutorial.
    56 
    85 
    57 Contribute
    86 Contribute
    58 ==========
    87 ==========
    59 
    88 
    60 Bugs are to be reported on the mercurial's bug tracker (component: evolution):
    89 Bugs are to be reported on the mercurial's bug tracker (component: evolution):