README
author Christian Ebert <blacktrash@gmx.net>
Sun, 07 Jun 2009 18:51:53 +0200
branch0.9.2compat
changeset 560 42502f8fc5b0
parent 322 b1ac738404f8
child 984 a4ea5c2d3ff3
permissions -rw-r--r--
(0.9.2compat) document Mercurial version range for standalone extension

$Id$

keyword extension for Mercurial SCM
===================================

[ standalone and backwards compatible version ]

CAVEAT: Only use this version with Mercurial 0.9.2 to 1.0.2!
With Mercurial > 1.0.2 use the extension included in the
distribution.

install
-------

Either copy hgkw/keyword.py into the hgext directory of your
Mercurial installation.
Then add the lines:

[extensions]
hgext.keyword =

to your hgrc file.

Or run "python setup.py install".
See also "pyton setup.py --help".
Then add the line:

[extensions]
keyword = /path/to/hgkw/keyword.py

to your hgrc, where /path/to/ is somewhere in your $PYTHONPATH.


first steps and online help
---------------------------

$ hg help keyword 
$ hg kwdemo


testing
-------

Copy hgkw/keyword.py into the hgext directory of your Mercurial
source tree. Copy tests/test-keyword, tests/test-keyword.out into
the tests directory of your Mercurial source tree. Change to that
directory and run:

$ python run-tests.py test-keyword

and then keep your fingers crossed ...