utils.rb: fix handling of require return value
[rbot] / REQUIREMENTS
1 Ruby modules needed for rbot
2 ============================
3
4 Core requirements
5       bdb (berkley db)      http://raa.ruby-lang.org/project/bdb/
6                             (which requires libdb4.x or better, formerly from
7                             www.sleepycat.com, now at
8                             http://www.oracle.com/technology/products/berkeley-db/index.html)
9                             Most of the time you don't need to compile anything.
10                             If you're running Linux, your distribution should
11                             have a libdb-ruby packaged (or similar).
12                             For Windows instructions, check at the bottom
13                             of this file.
14       net/http 1.2+
15       net/https             (for debian, this will also need libopenssl-ruby)
16       socket
17       uri
18
19 Useful but fallback provided
20       ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
21                             optional; if installed rbot can use localized messages
22       htmlentities          http://htmlentities.rubyforge.org/
23                             optional; if installed rbot will use it to decode
24                             HTML entities; if missing, an internal table with
25                             the most common HTML entities will be used instead
26       hpricot               http://code.whytheluckystiff.net/hpricot/
27                             optional, if installed rbot will used it to find
28                             the first paragraph in HTML files; if missing,
29                             regular expressions will be used instead
30
31
32 Plugin requirements
33 (these are all optional, if you don't have them, the plugins just won't
34 function)
35
36 bash, digg, slashdot, freshmeat, forecast:
37       REXML
38 rss:
39       rss
40 shortenurls:
41       shorturl
42 time:
43       tzinfo
44 translator:
45       mechanize
46
47 External programs needed for rbot
48 =================================
49
50 Plugin requirements
51 (These are all optional)
52
53 cal plugin:
54       cal(1)
55
56 figlet plugin:
57       figlet(6)
58
59 fortune plugin:
60       fortune(6)
61
62 host plugin:
63       host(1)
64
65 spell plugin:
66       ispell(1)
67
68
69 Running rbot on win32
70 =====================
71
72 You can install Ruby using the One-Click Ruby installer, available from
73 http://rubyinstaller.rubyforge.org/
74
75 You can find a precompiled version of the bdb package for ruby here
76 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
77
78 When you unpack the archive (e.g. using WinZip or 7-Zip or any other tool
79 of your choice) you'll notice that it contains the following directory structure:
80   usr
81    +---local
82          +---doc
83          +---lib
84 and you have to move the doc and lib folders (and all their contents) in the folder
85 where you installed Ruby (typically C:\Ruby\)
86
87
88 Further instructions
89 ====================
90
91 For further instructions, check http://ruby-rbot.org/rbot-trac/wiki/InstallGuide