plugin(imdb): fix title regex, closes #44

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

diff --git a/REQUIREMENTS b/REQUIREMENTS
index 5789d5fcc4d06834696827624cd690175833ef50..d367cb8b177496d470ce1efa6474b6103822d2e9 100644 (file)
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -2,31 +2,40 @@ 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)
-      net/http 1.2+
-      net/https             (for debian, this will also need libopenssl-ruby)
-      socket
-      uri
+      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
+                            you can install those requirement in debian like this:
+                            sudo aptitude install libtokyocabinet9 libtokyocabinet-dev zlib1g-dev libbz2-dev
+      sqlite3               for "sqlite" DB adaptor
+                            install with gem install sqlite,
+                            this also requires development libraries on the system to be present.
+      mechanize             install it using gem install mechanize

 
 Useful but fallback provided
       ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
 
 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     
+                            optional; if installed rbot can use localized messages

       htmlentities          http://htmlentities.rubyforge.org/
       htmlentities          http://htmlentities.rubyforge.org/

-                            optional, if missing rbot will use an internal table to decode
-                            the most common HTML entities
+                            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)
 

-bash, digg, slashdot, freshmeat, forecast:
-      REXML
-rss:
-      rss
-rubyurl:
+twitter:
+      oauth, oauth2
+
+shortenurls:

       shorturl
       shorturl

+

 time:
       tzinfo
 
 time:
       tzinfo
 


@@ -36,6 +45,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)
 


@@ -46,9 +64,15 @@ spell plugin:
 Running rbot on win32
 =====================
 
 Running rbot on win32
 =====================
 

-here is bdb:
-http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
+OMYGOD no!
+
+    http://www.fefe.de/nowindows/
+
+
+Further instructions
+====================

 
 

-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
+For further instructions, check https://github.com/4poc/rbot/wiki/Install-Guide
+For tips on handling the persistent plugin storage, backup, restore 
+and migration, check: https://github.com/4poc/rbot/wiki/Registry-Migration-Notes