Revise plugin documentation. Mainly, this removes remains of documentation
[squirrelmail.git] / plugins / bug_report / README
CommitLineData
7aa22276 1Bug Reporter
15e6162e 2
3Need to submit a bug? Need to know valuable system information? Need
4to be accurate? This should do it for you.
5
6
7Features
8========
9
10* You save yourself a lot of typing
11* By default, this is not enabled.
12* Provides detailed setup information to help diagnose your problem
13* Has some warnings that can help out the person submitting the bug report
14
15
16Description
17===========
18
19When people stumble across a bug, which may happen in a work-in-progress,
20often times they would like to help out the software and get rid of the bug.
21Sometimes, these people don't know much about the system and how it is set
22up -- they know enough to make the bug happen for them. This bug report
23plugin is designed to gather all of the non-private information for the user
24automatically, so that the user doesn't need to know more than how to trigger
25the bug.
26
27
28Future Work
29===========
30
31* Add more data
32* Add more warnings
33
34
35Installation
36============
37
7aa22276 38Go back to the main directory, run configure and add the plugin.
15e6162e 39
15e6162e 40
7aa22276 41Credits
15e6162e 42=======
7aa22276 43
44This plugin has been originally developed by Tyler Akins and is now
45maintained by the SquirrelMail Project Team.