Replace irrefutible pattern by error
[darcs-mirror-darcswatch.git] / README
1 darcswatch
2
3 © 2008-2010 Joachim Breitner <mail@joachim-breitner.de>
4
5 This program tracks darcs patches and repositories, giving
6 an overview over their state (applied or not applied).
7
8 The patches are expected to come in via the mailfilter.sh
9 program, which stores the patches in the appropriate place.
10
11 The main program then downloads the repository inventories
12 and compares the mailed patches against the repository. It
13 summaries their status per submitter and per repository.
14
15 The program expects a directory as a parameter and will read
16 the config file therein for configuration. An example
17 configuration is included.
18
19 DarcsWatch uses modules from these non-standard packages:
20  * xhtml
21  * network
22  * HTTP
23  * Crypto
24  * parsec
25  * nano-md5
26  * zlib
27  * concurrentoutput
28  * time
29  * mime-string
30  * regex-compat
31
32 There are a lot of open issues, and help is very
33 appreciated. A non exclusive list of TODO items is:
34
35  * Nicer output (CSS magic!)
36  * (Maybe) Add repositories per GnuPG signed command
37
38 When committing patches, please make sure that they work with
39 the version of GHC in the latest Debian stable release, at
40 the moment ghc6.6, and compatible libraries.
41
42 BTW, the simple darcs repository parsing code might be useful for
43 other projects as well. I try to keep the patches for the Darcs.hs
44 related stuff separate from the rest, so you can select them when
45 "darcs pull"ing. If you also follow this procedure, we can share the
46 Darcs.hs code between projects, by making sure our patches to these
47 files can be shared without dragging in the rest of the project.