README
changeset 35 2e7575352ef3
parent 34 714f9414b009
child 49 248ec36cef5f
equal deleted inserted replaced
34:714f9414b009 35:2e7575352ef3
     1 Artemis
     1 Artemis
     2 =======
     2 =======
     3 
     3 
     4 Artemis is a lightweight distributed issue tracking extension for Mercurial_.
     4 Artemis is a lightweight distributed issue tracking extension for Mercurial_.
     5 
     5 
     6 Individual issues are stored in directories in an ``.issues`` subdirectory. Each
     6 Individual issues are stored in directories in an ``.issues`` subdirectory
     7 one is a Maildir_ and each one is assumed to have a single root message.
     7 (overridable in a config file).  Each one is a Maildir_ and each one is assumed
     8 Various properties of an issue are stored in the headers of that message.
     8 to have a single root message.  Various properties of an issue are stored in the
       
     9 headers of that message.
     9 
    10 
    10 .. _Mercurial:      http://www.selenic.com/mercurial/
    11 .. _Mercurial:      http://www.selenic.com/mercurial/
    11 .. _Maildir:        http://en.wikipedia.org/wiki/Maildir
    12 .. _Maildir:        http://en.wikipedia.org/wiki/Maildir
    12 
    13 
    13 One can obtain Artemis by cloning its repository:
    14 One can obtain Artemis by cloning its repository:
    25 -----
    26 -----
    26 
    27 
    27 In the ``[extensions]`` section of your ``~/.hgrc`` add::
    28 In the ``[extensions]`` section of your ``~/.hgrc`` add::
    28     
    29     
    29     artemis = /path/to/artemis.py
    30     artemis = /path/to/artemis.py
       
    31 
       
    32 Optionally, provide a section ``[artemis]``, and specify an alternative path for
       
    33 the issues subdirectory (instead of the default ``.issues``)::
       
    34 
       
    35     [artemis]
       
    36     issues = _issues
    30 
    37 
    31 
    38 
    32 Example
    39 Example
    33 -------
    40 -------
    34 
    41