search: fix google calc scraping

[user/henk/code/ruby/rbot.git] / REQUIREMENTS

diff --git a/REQUIREMENTS b/REQUIREMENTS
index 93fe36c58b160dabc278d9c05553154ad14ef7a8..0e906daeb122959f40ca21ca262045bc067ad602 100644 (file)
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -2,14 +2,42 @@ Ruby modules needed for rbot
 ============================
 
 Core requirements
 ============================
 
 Core requirements

-      bdb (berkley db) http://www.ruby-lang.org/en/raa-list.rhtml?name=bdb
-                       (which requires libdb2 or better, from
-                       www.sleepycat.com)
+      tokyocabinet          for "tc" DB adaptor
+                            http://1978th.net/tokyocabinet/
+                            you can install Ruby bindings via "gem install tokyocabinet",
+                            but this still requires libtokyocabinet to be installed system-wide
+      bdb (berkeley db)      for "bdb" DB adaptor or converting from it
+                            http://raa.ruby-lang.org/project/bdb/
+                            (which requires libdb4.x or better, formerly from
+                            www.sleepycat.com, now at
+                            http://www.oracle.com/technology/products/berkeley-db/index.html)
+                            Most of the time you don't need to compile anything.
+                            If you're running Linux, your distribution should
+                            have a libdb-ruby packaged (or similar).
+                            For Windows instructions, check at the bottom
+                            of this file.
+
+      iconv                 this is needed by the httputil object and by the IRC engine
+                            to ensure consistent encoding across the bot
+

       net/http 1.2+
       net/http 1.2+

-      net/https        (for debian, this will also need libopenssl-ruby)
+      net/https             (for debian, this will also need libopenssl-ruby)

       socket
       uri
 
       socket
       uri
 

+Useful but fallback provided
+      ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
+                            optional; if installed rbot can use localized messages
+      htmlentities          http://htmlentities.rubyforge.org/
+                            optional; if installed rbot will use it to decode
+                            HTML entities; if missing, an internal table with
+                            the most common HTML entities will be used instead
+      hpricot               http://code.whytheluckystiff.net/hpricot/
+                            optional, if installed rbot will used it to find
+                            the first paragraph in HTML files; if missing,
+                            regular expressions will be used instead
+
+

 Plugin requirements
 (these are all optional, if you don't have them, the plugins just won't
 function)
 Plugin requirements
 (these are all optional, if you don't have them, the plugins just won't
 function)


@@ -18,10 +46,12 @@ bash, digg, slashdot, freshmeat, forecast:
       REXML
 rss:
       rss
       REXML
 rss:
       rss

-rubyurl:
+shortenurls:

       shorturl
 time:
       tzinfo
       shorturl
 time:
       tzinfo

+translator:
+      mechanize

 
 External programs needed for rbot
 =================================
 
 External programs needed for rbot
 =================================


@@ -29,6 +59,15 @@ External programs needed for rbot
 Plugin requirements
 (These are all optional)
 
 Plugin requirements
 (These are all optional)
 

+cal plugin:
+      cal(1)
+
+figlet plugin:
+      figlet(6)
+
+fortune plugin:
+      fortune(6)
+

 host plugin:
       host(1)
 
 host plugin:
       host(1)
 


@@ -39,9 +78,23 @@ spell plugin:
 Running rbot on win32
 =====================
 
 Running rbot on win32
 =====================
 

-here is bdb:
+You can install Ruby using the One-Click Ruby installer, available from
+http://rubyinstaller.rubyforge.org/
+
+You can find a precompiled version of the bdb package for ruby here

 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
 
 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
 

-and you need the Win32 MinGW version of Ruby:
-http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ruby-1.8.4-i386-mingw32.tar.gz
+When you unpack the archive (e.g. using WinZip or 7-Zip or any other tool
+of your choice) you'll notice that it contains the following directory structure:
+  usr
+   +---local
+         +---doc
+         +---lib
+and you have to move the doc and lib folders (and all their contents) in the folder
+where you installed Ruby (typically C:\Ruby\)
+
+
+Further instructions
+====================

 
 

+For further instructions, check http://ruby-rbot.org/rbot-trac/wiki/InstallGuide