summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--phenny_howto.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/phenny_howto.txt b/phenny_howto.txt
new file mode 100644
index 0000000..bcc7b59
--- /dev/null
+++ b/phenny_howto.txt
@@ -0,0 +1,24 @@
+This is a simple way to get pyscholar running as an IRC bot.
+
+1. Get phenny sources:
+
+git clone http://github.com/sbp/phenny.git
+
+2. Customize and put this config file into $HOME/.phenny/default.py:
+
+nick = 'bot nick'
+host = 'chat.freenode.net'
+channels = ['#botchannel']
+owner = 'your nick'
+
+# password = 'yourserverpassword'
+
+admins = [ owner ] # add more nicks if needed
+
+# Load pyscholar modules
+extra = [ 'path to pyscholar/phenny_doi.py', 'path to pyscholar/phenny_paper.py' ]
+
+# EOF
+
+3. Run phenny! You probably need to do it this way:
+ PYTHONPATH=path_to_pyscholar phenny