home · contact · privacy
Handle mobile twitter status URLs properly.
[plomlombot-irc.git] / README
diff --git a/README b/README
index 1238b40d28381213d43fe9e2ba1e502a4a4b8c30..d5202cb1c9d7b2f10f954786c6d3dbe072f637e1 100644 (file)
--- a/README
+++ b/README
@@ -1,2 +1,6 @@
-# plomlombot-irc
-irc bot
+Primitive IRC bot.
+
+Expects some external Python libraries (listed in requirements.txt). May be run
+directly if those dependencies are met. Otherwise, if at least pyvenv and pip
+are installed, run the bot via ./run.sh to set it up in a virtual environment
+into which the required libraries get installed automatically.