README-topic
branchstable
changeset 2259 94432e742a02
parent 2099 47017b3086d4
equal deleted inserted replaced
1814:efda653c96a7 2259:94432e742a02
       
     1 Topic Extension
       
     2 ================
       
     3 
       
     4 This packages also provides the ``topic`` experiment in an independent
       
     5 extension. It implements a new experimental concept to provide lightweight
       
     6 feature branches for the mutable parts of the history. The experiments is still
       
     7 at an early stage and have significant usability and performance issues when
       
     8 enabled.
       
     9 
       
    10 How to Install
       
    11 ==============
       
    12 
       
    13 The ``topic`` extension is included into the ``evolve` package, so the same instruction apply.
       
    14 
       
    15 Using Pip
       
    16 ---------
       
    17 
       
    18 You can install the latest version using pip::
       
    19 
       
    20     $ pip install --user hg-evolve
       
    21 
       
    22 Then just enable it in you hgrc::
       
    23 
       
    24     $ hg config --edit # adds the two line below:
       
    25     [extensions]
       
    26     topic =
       
    27 
       
    28 From Source
       
    29 -----------
       
    30 
       
    31 To install a local version from source::
       
    32 
       
    33     $ hg clone https://www.mercurial-scm.org/repo/evolve/
       
    34     $ cd evolve
       
    35     $ make install-home
       
    36 
       
    37 Enable
       
    38 ------
       
    39 
       
    40 The topic extensions is included in the evolve package. See the install instruction for evolve.
       
    41 
       
    42 Then enable it in you configuration::
       
    43 
       
    44     $ hg config --edit # adds the two line below:
       
    45     [extensions]
       
    46     topic =
       
    47 
       
    48 Documentation
       
    49 -------------
       
    50 
       
    51 * See 'hg help -e topic' for a generic help.
       
    52 * See 'hg help topics' and 'hg help stack' for help on specific commands.
       
    53 * See the 'tests/test-topic-tutorial.t' file for a quick tutorial.