Document the rough edges.

diff --git a/BUGS b/BUGS
new file mode 100644 (file)
index 0000000..1bee643
--- /dev/null
+++ b/BUGS
@@ -0,0 +1,11 @@
+                       KNOWN BUGS
+
+We apologize for the rough edges on this software.  The initial release
+was somewhat rushed by the sudden death of cia.vc in late Sptember 2012;
+a replacement needed to be fielded immediately.
+
+* irkbot.py does the default UDP send correctly, but something is not
+  quite right with the TCP-send code.
+
+* irkbot.py is intended to be a multi-VCS hook script that self-configures
+  from its environment, but it presently supports only git.

diff --git a/Makefile b/Makefile
index 500df423eda1211e79a0909fd7ac15a06959e4e2..a6cfca9b06ce98a9720915f60c62945038ea9e66 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -28,7 +28,7 @@ pylint:
        @pylint --output-format=parseable $(PYLINTOPTS) irkbot.py
 
 
-SOURCES = README COPYING NEWS irker irkbot.py Makefile irker.xml irker-logo.png
+SOURCES = README COPYING NEWS BUGS irker irkbot.py Makefile irker.xml irker-logo.png
 
 version:
        @echo $(VERS)

diff --git a/README b/README
index 3930d0306abbd044a42b0e7eab511364d55ee0de..5fa7cbaf3564b54e433273a8167109f7b81d0ebf 100644 (file)
--- a/README
+++ b/README
@@ -6,5 +6,9 @@ listening socket. It is meant to be used by hook scripts in version-
 control repositories, allowing them to send commit notifications
 to project IRC channels.  Hook scripts are included.
 
+Due to the abrupt death of cia.vc in later September 2012 the
+inmitial release of this software was a bit rushed.  See the file
+BUGS for known problems.
+
                                                Eric S. Raymond
                                                August 2012