1 .. -*- coding: utf-8 -*-

     2 

     3 .. _MercurialForestInstall:

     4 

     5 Installation of `CubicWeb` with Mercurial

     6 =========================================

     7 

     8 `CubicWeb` is available as a Mercurial repository using the forest extension.

     9 First make sure Mercurial is installed and that the forest extension is

    10 available.

    11 

    12 Mercurial installation

    13 ``````````````````````

    14 

    15 Please refer to the project online documentation Mercurial_.

    16 

    17 .. _Mercurial: http://www.selenic.com/mercurial/wiki/

    18 

    19 We also provide in this book a quick guide on how to use

    20 Mercurial (:ref:`MercurialPresentation`).

    21 

    22 

    23 Installation of the forest extension

    24 ````````````````````````````````````

    25 

    26 Set up the forest extension by getting a copy of the sources 

    27 from http://hg.akoha.org/hgforest/ and adding the following 

    28 lines to your ``~/.hgrc``: ::

    29 

    30    [extensions]

    31    hgext.forest=

    32    # or, if forest.py is not in the hgext dir:

    33    # forest=/path/to/forest.py

    34 

    35 Get `CubicWeb` source code

    36 ``````````````````````````

    37 

    38 Clone the forest in you working directory.

    39 

    40 ::

    41 

    42   hg fclone http://www.logilab.org/hg/forests/cubicweb

    43 

    44 .. note:: 

    45   We recommand you to create a symbolic link to the command ``cubicweb-ctl``

    46   as you will use it pretty often.

    47 

    48   ::

    49     

    50     $ ln -s /path/to/forest/cubicweb/bin/cubicweb-ctl ~/bin

    51 

    52