Skip to content

Commit 3bb851a

Browse files
author
Richard Jones
committed
Added a Features doc
1 parent f837352 commit 3bb851a

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

doc/features.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
================
2+
Roundup Features
3+
================
4+
5+
6+
Roundup is a simple-to-use and -install issue-tracking system with
7+
web, e-mail and command-line interfaces. It is based on the winning design
8+
from Ka-Ping Yee in the Software Carpentry "Track" design competition.
9+
10+
11+
*simple to use*
12+
- accessible through the web, email, command-line or Python programs
13+
14+
*simple to install*
15+
- installation takes about 10 minutes for a basic installation
16+
17+
*web interface*
18+
- fully editable interfaces for indexing and display of items
19+
- differentiates between anonymous, known and admin users
20+
- may be set up to require login, and may also only allow admin users
21+
to register new users
22+
23+
*e-mail interface*
24+
- may be set up using sendmail-like delivery alias, POP polling or mailbox
25+
polling
26+
- issues have their own mini mailing list (nosy list)
27+
- nosy list configuration controls how people are added and when messages
28+
are sent to the list
29+
- auto-filing of "unformatted" messages into a particular class
30+
31+
*command-line*
32+
- may be used to interactively manage roundup databases
33+
- may be scripted using standard shell scripting
34+

doc/index.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Roundup: an Issue-Tracking System for Knowledge Workers
55
Contents
66
========
77

8+
- Features_
89
- Overview_
910
- Installation_
1011
- `Getting Started`_
@@ -16,6 +17,7 @@ Contents
1617
- Acknowledgements_
1718
- License_
1819

20+
.. _Features: features.html
1921
.. _Overview: overview.html
2022
.. _Installation: installation.html
2123
.. _`Getting Started`: getting_started.html

0 commit comments

Comments
 (0)