README
author Christian Ebert <blacktrash@gmx.net>
Mon, 03 Sep 2007 06:11:07 +0200
changeset 239 a0b8165fcec9
parent 190 README.txt@100d35923d5f
child 321 ce5474dd2a9a
permissions -rw-r--r--
Rename README.txt to README
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
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     6
install
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     7
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     8
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     9
Either copy hgkw/keyword.py into the hgext directory of your
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    10
Mercurial installation.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    11
Then add the lines:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    12
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    13
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    14
hgext.keyword =
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    15
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    16
to your hgrc file.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    17
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    18
Or run "python setup.py install".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    19
See also "pyton setup.py --help".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    20
Then add the line:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    21
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    22
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    23
keyword = /path/to/hgkw/keyword.py
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    24
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    25
to your hgrc, where /path/to/ is somewhere in your $PYTHONPATH.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    26
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    27
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    28
first steps and online help
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    29
---------------------------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    30
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    31
$ hg keyword help
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    32
$ hg kwdemo
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    33
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    34
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    35
testing
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    36
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    37
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    38
Copy hgkw/keyword.py into the hgext directory of your Mercurial
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    39
source tree. Copy tests/test-keyword, tests/test-keyword.out into
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    40
the tests directory of your Mercurial source tree. Change to that
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    41
directory and run:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    42
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    43
$ python run-tests.py test-keyword
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    44
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    45
and then keep your fingers crossed ...