Added a Features doc

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@752 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/doc/features.txt b/doc/features.txt
new file mode 100644 (file)
index 0000000..dbfb73f
--- /dev/null
+++ b/doc/features.txt
@@ -0,0 +1,34 @@
+================
+Roundup Features
+================
+
+
+Roundup is a simple-to-use and -install issue-tracking system with
+web, e-mail and command-line interfaces. It is based on the winning design
+from Ka-Ping Yee in the Software Carpentry "Track" design competition.
+
+
+*simple to use*
+ - accessible through the web, email, command-line or Python programs
+
+*simple to install*
+ - installation takes about 10 minutes for a basic installation
+
+*web interface*
+ - fully editable interfaces for indexing and display of items
+ - differentiates between anonymous, known and admin users
+ - may be set up to require login, and may also only allow admin users
+   to register new users
+
+*e-mail interface*
+ - may be set up using sendmail-like delivery alias, POP polling or mailbox
+   polling
+ - issues have their own mini mailing list (nosy list)
+ - nosy list configuration controls how people are added and when messages
+   are sent to the list
+ - auto-filing of "unformatted" messages into a particular class
+
+*command-line*
+ - may be used to interactively manage roundup databases
+ - may be scripted using standard shell scripting
+

diff --git a/doc/index.txt b/doc/index.txt
index d2f18fdfa945532fe3906b0b8141e37df0ca61f4..987225550098cd839e2c715e1eb997ac01de2b3c 100644 (file)
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -5,6 +5,7 @@ Roundup: an Issue-Tracking System for Knowledge Workers
 Contents
 ========
 
+- Features_
 - Overview_
 - Installation_
 - `Getting Started`_
@@ -16,6 +17,7 @@ Contents
 - Acknowledgements_
 - License_
 
+.. _Features: features.html
 .. _Overview: overview.html
 .. _Installation: installation.html
 .. _`Getting Started`: getting_started.html