summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2015-10-28 21:51:08 +0200
committerLars Wirzenius <liw@liw.fi>2015-10-28 21:51:08 +0200
commitdb29117e2d596a0829e9247e0e2ceb97db11dfec (patch)
tree4e99629b00b5a1c510e8c91601cb959ac34fe290 /README
parente9353b54d511e652f8bc0d6080327cc709a9f662 (diff)
downloaddistix-db29117e2d596a0829e9247e0e2ceb97db11dfec.tar.gz
Add a blurb to README
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 13 insertions, 6 deletions
diff --git a/README b/README
index 9ce5a3b..7cefb7e 100644
--- a/README
+++ b/README
@@ -6,12 +6,19 @@ README for distix
eventually. Any similarity with reality is accidental, but we'll
take credit for it anyway.***
-distix is a distributed ticketing system. It stores the data in git,
-using yaml and Maildirs.
+Blurb
+-----
-FIXME: This part of the README should contain some explanation of why
-a new system, and what the important features of distix are. However,
-I'll want to word that carefully, so I'll do it later.
+distix is a distributed ticketing system, aimed at handling support
+issues and bugs. For most people, it is an invisible agent that keeps
+track of issues and bugs by being Cc'd on emails. There is no login
+required. The emails do not need to follow any structure. Each email
+thread becomes its own ticket. The support staff can search and
+manipulate tickets using a command line tool.
+
+distix is built using git, YAML, and Maildirs. This allows tickets to
+be handled entirely offline, and synchronised between machines and
+staff. There is currently no web interface.
Hacking
@@ -48,7 +55,7 @@ Code should be developed using test driven development.
Legalese
--------
-Copyright 2014 Lars Wirzenius
+Copyright 2014,2015 Lars Wirzenius
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by