README
author Christian Ebert <blacktrash@gmx.net>
Sun, 07 Jun 2009 18:59:18 +0200
changeset 561 efeb09cb3760
parent 321 ce5474dd2a9a
child 562 b1aa7b64890b
permissions -rw-r--r--
Refer users to distribution or 0.9.2compat branch
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     1
$Id$
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     2
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     3
keyword extension for Mercurial SCM
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     4
===================================
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     5
561
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     6
CAVEAT: Please use the keyword extension distributed with
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     7
Mercurial > 1.0.2!
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     8
For Mercurial 0.9.2 to 1.0.2 install the 0.9.2compat branch.
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     9
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
    10
The default and stable branches are meant for development.
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
    11
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    12
install
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    13
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    14
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    15
Either copy hgkw/keyword.py into the hgext directory of your
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    16
Mercurial installation.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    17
Then add the lines:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    18
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    19
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    20
hgext.keyword =
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    21
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    22
to your hgrc file.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    23
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    24
Or run "python setup.py install".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    25
See also "pyton setup.py --help".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    26
Then add the line:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    27
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    28
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    29
keyword = /path/to/hgkw/keyword.py
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    30
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    31
to your hgrc, where /path/to/ is somewhere in your $PYTHONPATH.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    32
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    33
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    34
first steps and online help
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    35
---------------------------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    36
321
ce5474dd2a9a README: fix help instruction
Christian Ebert <blacktrash@gmx.net>
parents: 239
diff changeset
    37
$ hg help keyword 
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    38
$ hg kwdemo
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    39
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    40
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    41
testing
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    42
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    43
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    44
Copy hgkw/keyword.py into the hgext directory of your Mercurial
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    45
source tree. Copy tests/test-keyword, tests/test-keyword.out into
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    46
the tests directory of your Mercurial source tree. Change to that
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    47
directory and run:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    48
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    49
$ python run-tests.py test-keyword
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    50
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    51
and then keep your fingers crossed ...