Adjusted README.md with minor structural changes and edits

[debbugs.git] / README.md

diff --git a/README.md b/README.md
index f925c5020c149d38cb6e0e7fc9235b565ca8845f..ca9f0ee9eb0667fd0b07e32f8ce5aaf8764e1863 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,17 +4,10 @@
 
 ********************************
 
-### Developers ###
-
-This bug tracking system was developed by Ian Jackson from 1994-1997,
-with assistance from nCipher Corporation Limited in 1997.  nCipher allowed
-Ian to redistribute modifications he made to the system while working as an
-employee of nCipher.
+### What is Debbugs ###
+Debbugs is a stable, scaleable bug reporting and issue tracking system. Debbugs has a web interface for viewing and searching issues in the database but unlike other bug tracking systems, Debbugs has no web interface for editing bug reports - all modification is done via email.
 
-Since then, it has been developed by the various administrators of
-bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
-Towns, and Colin Watson.  As in the case of Ian, nCipher allowed Colin to
-redistribute modifications he made while working as an employee of nCipher.
+The most notable deployment of Debbugs is on the [Debian project](https://www.debian.org/Bugs/)
 
 ### System Requirements ###
 
@@ -70,9 +63,7 @@ follows:
 
 If you need a template, look in `/usr/share/doc/debbugs/examples/` directory.
 
-### Contributing to Debbugs ###
-
-#### Getting the Source Code ####
+### Where do I get the Source? ###
 
 Debbugs is managed in git. You can clone the repository into your local
 workspace as follows:
@@ -83,6 +74,15 @@ Additional branches are available from:
 
  * [Don Armstrong](http://git.donarmstrong.com/debbugs.git/)
 
+### How do I contribute to Debbugs? ###
+ 
+#### Debbugs for Debbugs ####
+
+Debbugs bugs are tracked using Debbugs. The web interface is available:
+[Debbugs bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=no&src=debbugs)
+
+#### Start contributing ####
+
 Make a working branch for your code and check it out to start working:
 
     git checkout -b example-branch
@@ -110,7 +110,7 @@ attached to the bug report for the issue. This can be done by emailing the
 Feature patches can also be emailed to the maintaining list at 
 [Debugs mailing list](debian-debbugs@lists.debian.org)
 
-### Further Information ###
+### Further Information and Assistance ###
 
 #### Email ####
 
@@ -122,7 +122,24 @@ Feature patches can also be emailed to the maintaining list at
 
 #### Website ####
 
+   * [Code](https://bugs.debian.org/debbugs-source/debbugs.git/)
+   * [Debbugs Team](https://wiki.debian.org/Teams/Debbugs|Debbugs Team)
 
+#### IRC ####
+
+Join the #debbugs channel on [OFTC](irc.oftc.net)
+
+### Developers ###
+
+This bug tracking system was developed by Ian Jackson from 1994-1997,
+with assistance from nCipher Corporation Limited in 1997. nCipher allowed
+Ian to redistribute modifications he made to the system while working as an
+employee of nCipher.
+
+Since then, it has been developed by the various administrators of
+bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
+Towns, and Colin Watson. As in the case of Ian, nCipher allowed Colin to
+redistribute modifications he made while working as an employee of nCipher.
 
 ### Copyright and Lack-of-Warranty Notice ###