README
changeset 35 2e7575352ef3
parent 34 714f9414b009
child 49 248ec36cef5f
--- a/README	Sat Apr 11 15:44:02 2009 -0700
+++ b/README	Wed Jan 13 09:52:28 2010 -0800
@@ -3,9 +3,10 @@
 
 Artemis is a lightweight distributed issue tracking extension for Mercurial_.
 
-Individual issues are stored in directories in an ``.issues`` subdirectory. Each
-one is a Maildir_ and each one is assumed to have a single root message.
-Various properties of an issue are stored in the headers of that message.
+Individual issues are stored in directories in an ``.issues`` subdirectory
+(overridable in a config file).  Each one is a Maildir_ and each one is assumed
+to have a single root message.  Various properties of an issue are stored in the
+headers of that message.
 
 .. _Mercurial:      http://www.selenic.com/mercurial/
 .. _Maildir:        http://en.wikipedia.org/wiki/Maildir
@@ -28,6 +29,12 @@
     
     artemis = /path/to/artemis.py
 
+Optionally, provide a section ``[artemis]``, and specify an alternative path for
+the issues subdirectory (instead of the default ``.issues``)::
+
+    [artemis]
+    issues = _issues
+
 
 Example
 -------