diff --git a/README.md b/README.md index c0f37e8..f7dfe4b 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,29 @@ LolBot A naff IRC bot I rattled off in a hurry once, for folks stuck behind censor walls at work. Logs a channel and collects up all the URLs for later. - -Rewritten based on Twisted for now. One day they might port Twisted to Python 3. - +It was refactored for Twisted in 2011, then again to use pypi irc in 2015. Has recently grown a quiz feature based on MoxQuizz, which might actually turn into something useful one day. + +Installation +------------ + +To get started, set up a Python virtual environment, and install the stuff in +`requirements.txt`. + + apt-get install python-virtualenv + +Clone this git repository, and in the directory: + + virtualenv env + env/bin/pip install -r requirements.txt + +Then you can run the bot like so: + + env/bin/python lolbot.py + +Development +----------- + +Patches welcome! Development currently happens on the New Zealand Open Source +Society [GitLab](https://git.nzoss.org.nz/moxquizz-fans/lolbot). diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1401a04 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +SQLAlchemy==1.0.9 +argparse==1.2.1 +irc==11.0.1 +jaraco.timing==1.1.5 +jaraco.util==10.6 +mechanize==0.2.5 +more-itertools==2.2 +six==1.10.0 +wsgiref==0.1.2