git.oblomov.eu Git - rbot/blob - REQUIREMENTS

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