home · contact · privacy
Improve README.
authorChristian Heller <c.heller@plomlompom.de>
Tue, 19 Jan 2016 22:44:52 +0000 (23:44 +0100)
committerChristian Heller <c.heller@plomlompom.de>
Tue, 19 Jan 2016 22:44:52 +0000 (23:44 +0100)
README

diff --git a/README b/README
index 1238b40..d5202cb 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.